{ "opencollection": "1.0.0", "info": { "name": "PagerDuty Abilities Webhooks API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "PagerDuty List webhook subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/webhook_subscriptions", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results per page." }, { "name": "offset", "value": "", "type": "query", "description": "Offset to start pagination search results." }, { "name": "total", "value": "", "type": "query", "description": "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.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n" }, { "name": "filter_type", "value": "", "type": "query", "description": "The type of resource to filter upon." }, { "name": "filter_id", "value": "", "type": "query", "description": "The id of the resource to filter upon." } ] }, "docs": "List existing webhook subscriptions.\n\nThe `filter_type` and `filter_id` query parameters may be used to only show subscriptions\nfor a particular _service_ or _team_.\n\nFor more information on webhook subscriptions and how they are used to configure v3 webhooks\nsee the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).\n\nScoped OAuth requires: `webhook_subscriptions.read`\n" }, { "info": { "name": "PagerDuty Create a webhook subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/webhook_subscriptions", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new webhook subscription.\n\nFor more information on webhook subscriptions and how they are used to configure v3 webhooks\nsee the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).\n\nScoped OAuth requires: `webhook_subscriptions.write`\n" }, { "info": { "name": "PagerDuty Get a webhook subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/webhook_subscriptions/:id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Gets details about an existing webhook subscription.\n\nScoped OAuth requires: `webhook_subscriptions.read`\n" }, { "info": { "name": "PagerDuty Update a webhook subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/webhook_subscriptions/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing webhook subscription.\n\nOnly the fields being updated need to be included on the request. This operation does not\nsupport updating the `delivery_method` of the webhook subscription.\n\nScoped OAuth requires: `webhook_subscriptions.write`\n" }, { "info": { "name": "PagerDuty Delete a webhook subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/webhook_subscriptions/:id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Deletes a webhook subscription.\n\nScoped OAuth requires: `webhook_subscriptions.write`\n" }, { "info": { "name": "PagerDuty Enable a webhook subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/webhook_subscriptions/:id/enable", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Enable a webhook subscription that is temporarily disabled. (This API does not require a request body.)\n\nWebhook subscriptions can become temporarily disabled when the subscription's delivery method is repeatedly rejected by the server.\n\nScoped OAuth requires: `webhook_subscriptions.write`\n" }, { "info": { "name": "PagerDuty Test a webhook subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/webhook_subscriptions/:id/ping", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Test a webhook subscription.\n\nFires a test event against the webhook subscription. If properly configured,\nthis will deliver the `pagey.ping` webhook event to the destination.\n\nScoped OAuth requires: `webhook_subscriptions.write`\n" } ] } ], "bundled": true }