Settings
Get Webhook status
Gets the status of communication with your app’s webhook.
GET
/
settings
/
webhook
Response
Might return an empty body if there’s no settings yet stored for your account.
webhookEnabled
string
requiredIndicates whether the webhook is currently enabled, and working properly.
webhookStatusDetail
string
The message indicating the reason for the webhook being disabled, or ‘OK’ if the webhook is enabled. This gets updated with the message of the last failed request to the webhook.
webhookRequestsProcessing
number
requiredThe number of webhook requests currently being processed. It gets updated as the requests are processed.
webhookRequestsFailed
number
requiredThe number of failed webhook requests for your acccount. It gets updated as the retries are attempted.
Example response:
{
"webhookEnabled": false,
"webhookStatusDetail": "Request failed with status code 404",
"webhookRequestsProcessing": 0,
"webhookRequestsFailed": 3
}