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

createdAtstring date-time required
descriptionstring required
disabledboolean
eventTypesstring[] nullable
idstring required

The Endpoint's ID.

metadataobject required
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.

updatedAtstring date-time required
urlstring uri required

Example response

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

Changes

Changed in 1 of the 5 revisions of this API.21

  • dc130bd1b07421See the full diff
    • removed the optional property filterTypes from the response with the 200 status

      response-optional-property-removed

    • removed the optional property rateLimit from the response with the 200 status

      response-optional-property-removed

    • added the optional property eventTypes to the response with the 200 status

      response-optional-property-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog