webhook-subscriptions

List webhook subscriptions

Returns a paginated list of webhook subscriptions scoped to the caller account.

get/api/v1/webhook-subscriptions

Query parameters

qstring

Free-text search with case-insensitive partial match on name and url.

statusstring
eventTypestring
pagenumber
limitnumber
sortBystring
sortOrderstring

Response

Paginated list of webhook subscriptions.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.14

    • added the new optional query request parameter eventType

      new-optional-request-parameter

    • added the new optional query request parameter limit

      new-optional-request-parameter

    • added the new optional query request parameter page

      new-optional-request-parameter

    • added the new optional query request parameter sortBy

      new-optional-request-parameter

    • added the new optional query request parameter sortOrder

      new-optional-request-parameter

    • added the new optional query request parameter status

      new-optional-request-parameter

    • added the required property data/items/created_at to the response with the 200 status

      response-required-property-added

    • added the required property data/items/disabled_at to the response with the 200 status

      response-required-property-added

    • added the required property data/items/event_types to the response with the 200 status

      response-required-property-added

    • added the required property data/items/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/name to the response with the 200 status

      response-required-property-added

    • added the required property data/items/updated_at to the response with the 200 status

      response-required-property-added

    • added the required property data/items/url to the response with the 200 status

      response-required-property-added

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

    • endpoint added

      endpoint-added

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