v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Webhook Endpoint

Create Operational Webhook Endpoint

Create an operational webhook endpoint.

post/api/v1/operational-webhook/endpoint

Headers

idempotency-keystring

The request's idempotency key

Request body

urlstring uri required

descriptionstring

rateLimitinteger nullable

Deprecated, use throttleRate instead.

throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

disabledboolean

filterTypesstring[] nullable

secretstring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

metadataobject

Example request

{
  "url": "https://example.com/webhook/",
  "description": "An example endpoint name",
  "uid": "unique-identifier",
  "filterTypes": [
    "message.attempt.failing"
  ],
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Response

idstring required

The Endpoint's ID.

urlstring uri required

descriptionstring required

rateLimitinteger nullable

Deprecated, use throttleRate instead.

throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

disabledboolean

filterTypesstring[] nullable

createdAtstring date-time required

updatedAtstring date-time required

metadataobject required

Example response

{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "url": "https://example.com/webhook/",
  "uid": "unique-identifier",
  "filterTypes": [
    "message.attempt.failing"
  ]
}