Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Webhooks

List webhook subscriptions

List existing webhook subscriptions.

The filter_type and filter_id query parameters may be used to only show subscriptions for a particular service or team.

For more information on webhook subscriptions and how they are used to configure v3 webhooks see the Webhooks v3 Developer Documentation.

Scoped OAuth requires: webhook_subscriptions.read

get/webhook_subscriptions

Query parameters

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

totalboolean

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated.

See our Pagination Docs for more information.

filter_type'account' | 'service' | 'team'

The type of resource to filter upon.

filter_idstring

The id of the resource to filter upon. Required if filter_type is service or team.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Response

A set of webhook subscriptions matching the request.

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.

Example response

{
  "webhook_subscriptions": [
    {
      "oauth_client": {
        "id": "AGMEB7F7YJYELCPG4Y5YWMYGXE",
        "type": "oauth_client_reference",
        "summary": "PagerDuty Webhook Integration"
      }
    }
  ]
}