Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-04-145745483.2 KB
VerifyV2Webhook

Create a new Webhook for the Service

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

sidstring nullable

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

service_sidstring nullable

The unique SID identifier of the Service.

account_sidstring nullable

The SID of the Account that created the Service resource.

friendly_namestring nullable

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

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

status'enabled' | 'disabled'

The webhook status. Default value is enabled. One of: enabled or disabled

version'v1' | 'v2'

The webhook version. Default value is v2 which includes all the latest fields. Version v1 is legacy and may be removed in the future.

webhook_urlstring uri nullable

The URL associated with this Webhook.

webhook_method'GET' | 'POST'

The method to be used when calling the webhook's URL.

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.

urlstring uri nullable

The absolute URL of the Webhook resource.