v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Webhook Endpoint

Upsert Operational Webhook Endpoint

Create or update an operational webhook endpoint.

put/api/v1/operational-webhook/endpoint/{endpoint_id}

Path parameters

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

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

metadataobject

Example request

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

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"
  ]
}