Webhook settings resources

Get Webhook settings

GET /settings/web-hook

Response

{
    "enabled": true,
    "url": "https://webhook.example.com/webhook",
    "secret": "webhook_secret_key",
    "events": ["notifications"]
}


Update Webhook settings

PUT /settings/web-hook

Note: If a setting key is omitted the setting is ignored. If the value for a setting is set to null the respective setting is reset to its default value.

Parameter Type Default Description
enabled boolean false If webhook requests are enabled.
url url - URL to which the webhook request is made.
secret string - Optional secret key with which the payload is signed.
events Array ["notifications"] Contains a set of event types that trigger webhook requests. Currently, only the event type notifications is supported.

Response

{
    "enabled": true,
    "url": "https://webhook.example.com/webhook",
    "secret": "webhook_secret_key",
    "events": ["notifications"]
}