| id |
str |
The unique identifier of the webhook. Read-only. |
[optional] |
| token |
str |
Webhook secret token used to sign the webhook's payload. Read-only. |
[optional] |
| href |
str |
The API endpoint to retrieve the webhook. Read-only. |
[optional] |
| url |
str |
The url that will listen to notifications (must be https). |
|
| enabled |
bool |
Determine if the webhook is active. |
[optional] |
| environments |
list[str] |
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] |
| events |
list[str] |
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] |