POST
/
settings

Body

webhookUrl
string
required

The webhook URL to be stored with your settings. It should be a valid URL.

For requirements for this URL, see our Webhooks guide.

Response

id
string
required

The settings ID.

webhookUrl
string
required

Your application’s webhook URL.

webhookKey
string
required

The key used to authenticate webhook calls to your app.

Example response:

{
  "id": "<settings-id>",
  "webhookUrl": "https://server.domain.com/webhook/endpoint",
  "webhookKey": "<webhook-key>"
}