Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 1.26 KB

WebhookResponse.md

File metadata and controls

15 lines (12 loc) · 1.26 KB

# WebhookResponse

Properties

Name Type Description Notes
id string The unique identifier of the webhook. [optional]
url string The url that will listen to notifications (must be https).
enabled bool Determine if the webhook is active. [optional]
events string[] The events that will be published to the webhook. The supported events are: `report.completed`, `report.withdrawn`, `check.completed`, `check.started`, `check.form_opened`, `check.form_completed`. If the events parameter is omitted all the events will be subscribed. [optional]
token string Webhook secret token used to sign the webhook's payload. [optional]
href string The API endpoint to retrieve the webhook. [optional]
environments string[] The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments. [optional]

[Back to Model list] [Back to API list] [Back to README]