GET /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

Servers

Request headers

Name Type Required Description
Accept String Yes

The Accept header is used as a versioning header.

Default value: "application/vnd.pagerduty+json;version=2"

Query parameters

Name Type Required Description
filter_id String No

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

filter_type String No

The type of resource to filter upon.

Possible values:

  • "account"
  • "service"
  • "team"
limit Integer No

The number of results per page.

offset Integer No

Offset to start pagination search results.

total Boolean No

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.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.