POST /status_pages/{id}/subscriptions

Create a Subscription for a Status Page by Status Page ID.

Scoped OAuth requires: status_pages.write

Servers

Path parameters

Name Type Required Description
id String Yes

The ID of the resource.

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"

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
subscription Object Yes

Request schema for creating a StatusPageSubscription.

subscription.contact String Yes

The subscriber's contact - email address or webhook URL.

subscription.channel String Yes

The channel of the Subscription.

Possible values:

  • "email"
  • "webhook"
subscription.subscribable_object Object Yes

The subscribed entity for a given subscription.

subscription.subscribable_object.id String No

The ID of the subscribed entity for a given subscription.

subscription.subscribable_object.type String No

The type of the subscribed entity for a given subscription.

Possible values:

  • "status_page_service"
  • "status_page"
  • "status_page_post"
subscription.type String Yes

A string that determines the schema of the object.

subscription.status_page Object Yes

Status Page

subscription.status_page.id String Yes

The id of the status page.

subscription.status_page.type String No

A string that determines the schema of the object.

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.