Register an outbound endpoint

POST

/accounts/{accountId}/endpoints

• Production management API
• Development stage

Authorizations

• bearerAuth

Parameters

Path Parameters

accountId

required

string

Request Body ^required

object

url

required

string format: uri

https://hooks.example.com/2mee

eventTypes

required

Array<string>

[
  "experience.goal.reached",
  "experience.ended"
]

Responses

201

Created. Returns the endpoint and its signing secret (shown once).

object

endpointId

string

ep_44ab

url

string format: uri

eventTypes

Array<string>

status

string

Allowed values: active paused disabled

createdAt

string format: date-time

secret

string

401

Missing or invalid authentication/signature.

object

error

object

code

string

invalid_signature

message

string

requestId

string

422

URL failed validation (not HTTPS, or resolves to a blocked range).