Skip to content

Files

Latest commit

author
Peter IJlst
Feb 26, 2019
3361bc6 · Feb 26, 2019

History

History
16 lines (11 loc) · 1.25 KB

Webhook.md

File metadata and controls

16 lines (11 loc) · 1.25 KB

Webhook

Properties

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