Create a Subscription

Creates a new subscription based on the provided data.

How signing requests work

When setting up, it's common to generate, store, and share a secret between your app and the app that wants to receive webhooks. The secret should be a random string, and how to create it is entirely up to you. The package will use the secret to sign a webhook call. By default, the package will add a header called Signature that will contain a signature the receiving app can use if the payload hasn't been tampered with.

Required scope: subscriptions:write

Body Params

New subscription data

string
required
length ≤ 1024

The callback URL of the subscription.

string
required
length between 6 and 64

The secret key is used to generate a secure signature with the HMAC-SHA256 hashing algorithm, which is included in the webhook event Signature header.

events
array of strings
required
length ≤ 1000

Subscription events

events*
Headers
string
length between 10 and 100

Provide a random key (for example, UUID) to make the request idempotent

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json