Path parameters

• ServiceSid string Required

  The unique SID identifier of the Service.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.

Responses

• 201 application/json

  Created

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • sid string | null

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^YW[0-9a-fA-F]{32}$.

  • service_sid string | null

    The unique SID identifier of the Service.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.

  • account_sid string | null

    The SID of the Account that created the Service resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • friendly_name string | null

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

  • event_types array[string] | null

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

  • status string

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

    Values are enabled or disabled.

  • version string

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

    Values are v1 or v2.

  • webhook_url string(uri) | null

    The URL associated with this Webhook.

  • webhook_method string

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

    Values are GET or POST.

  • date_created string(date-time) | null

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

  • date_updated string(date-time) | null

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

  • url string(uri) | null

    The absolute URL of the Webhook resource.