Webhook Endpoint

List Operational Webhook Endpoints

List operational webhook endpoints.

get/api/v1/operational-webhook/endpoint

Query parameters

limitinteger

Limit the number of returned items

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:ep_1srOrx2ZWZBpBUvZwXKQmoEYga2

The iterator returned from a prior invocation

order'ascending' | 'descending'

Defines the ordering in a listing of results.

The sorting order of the returned items

Response

doneboolean required
iteratorstring nullable required
prevIteratorstring nullable

Example response

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

Changes

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

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

      response-optional-property-removed

    • removed the optional property data/items/rateLimit from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/items/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