v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Webhook Endpoint

Get Operational Webhook Endpoint

Get an operational webhook endpoint.

get/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.

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