Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

Create a new Webhook for the Service

post/v2/Services/{ServiceSid}/Webhooks

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Response

Created

account_sidstring nullable

The SID of the Account that created the Service resource.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

event_typesstring[] nullable

The array of events that this Webhook is subscribed to. Possible event types: *, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied

friendly_namestring nullable

The string that you assigned to describe the webhook. This value should not contain PII.

service_sidstring nullable

The unique SID identifier of the Service.

sidstring nullable

The unique string that we created to identify the Webhook resource.

status'enabled' | 'disabled'
urlstring uri nullable

The absolute URL of the Webhook resource.

version'v1' | 'v2'
webhook_method'GET' | 'POST'
webhook_urlstring uri nullable

The URL associated with this Webhook.