Skip to main content

Create new webhook​

Request Body
  • enabled boolean
  • endpoint string required

    Possible values: <= 255 characters

  • failures_email string

    Email address to send failure notifications

  • response_format string

    Possible values: [json, xml]

  • number_acl object

    A webhook can be configured with a list of service_numbers and a type. When the type is set to 'allow', and a list is passed in, the webhook will only trigger for calls on the specified service_numbers. When the type is set to 'block', and a list is passed in, it will not trigger on the specified service_numbers. By default, webhooks trigger for all service_numbers.

  • type string

    Possible values: [allow, block]

  • service_numbers string[]

    Possible values: Value must match regular expression ^[0-9]{1,14}$

  • url_acl object

    A webhook can be configured with a list of va_codes and a type. When the type is set to 'allow', and a list is passed in, the webhook will only trigger for calls on the specified va_codes. When the type is set to 'block', and a list is passed in, it will not trigger on the specified va_codes. By default, webhooks trigger for all va_codes.

  • type string

    Possible values: [allow, block]

  • va_codes string[]
  • destination_acl object

    A webhook can be configured with a list of destinations and a type. When the type is set to 'allow', and a list is passed in, the webhook will only trigger for calls on the specified destinations. When the type is set to 'block', and a list is passed in, it will not trigger on the specified destinations. By default, webhooks trigger for all destinations.

  • type string

    Possible values: [allow, block]

  • destinations string[]

    Possible values: Value must match regular expression ^[0-9]{1,14}$

  • custom_payload string
Responses
Schema
  • id integer

    Webhook id

  • last_successful_endpoint_response string
  • enabled boolean
  • endpoint string
  • failures_email string

    Email address to send failure notifications

  • response_format string

    Possible values: [json, xml]

  • number_acl object

    A webhook can be configured with a list of service_numbers and a type. When the type is set to 'allow', and a list is passed in, the webhook will only trigger for calls on the specified service_numbers. When the type is set to 'block', and a list is passed in, it will not trigger on the specified service_numbers. By default, webhooks trigger for all service_numbers.

  • type string

    Possible values: [allow, block]

  • service_numbers string[]

    Possible values: Value must match regular expression ^[0-9]{1,14}$

  • url_acl object

    A webhook can be configured with a list of va_codes and a type. When the type is set to 'allow', and a list is passed in, the webhook will only trigger for calls on the specified va_codes. When the type is set to 'block', and a list is passed in, it will not trigger on the specified va_codes. By default, webhooks trigger for all va_codes.

  • type string

    Possible values: [allow, block]

  • va_codes string[]
  • destination_acl object

    A webhook can be configured with a list of destinations and a type. When the type is set to 'allow', and a list is passed in, the webhook will only trigger for calls on the specified destinations. When the type is set to 'block', and a list is passed in, it will not trigger on the specified destinations. By default, webhooks trigger for all destinations.

  • type string

    Possible values: [allow, block]

  • destinations string[]

    Possible values: Value must match regular expression ^[0-9]{1,14}$

  • custom_payload string