Create channel webhook

POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks
Account sid auth token

Webhooks for specific channels

Path parameters

  • ServiceSid string Required

    The SID of the Service with the Channel to create the Webhook resource under.

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

  • ChannelSid string Required

    The SID of the Channel the new Channel Webhook resource belongs to. This value can be the Channel resource's sid or unique_name.

application/x-www-form-urlencoded

Body

  • Type string Required

    The type of webhook. Can be: webhook, studio, or trigger.

    Values are webhook, trigger, or studio.

  • Configuration.Url string

    The URL of the webhook to call using the configuration.method.

  • Configuration.Method string

    Values are GET or POST.

  • Configuration.Filters array[string]

    The events that cause us to call the Channel Webhook. Used when type is webhook. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see Webhook Event Triggers.

  • Configuration.Triggers array[string]

    A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when type = trigger.

  • Configuration.FlowSid string

    The SID of the Studio Flow to call when an event in configuration.filters occurs. Used only when type is studio.

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

  • Configuration.RetryCount integer

    The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.

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 Channel Webhook resource.

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

    • account_sid string | null

      The SID of the Account that created the Channel Webhook resource.

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

    • service_sid string | null

      The SID of the Service the Channel Webhook resource is associated with.

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

    • channel_sid string | null

      The SID of the Channel the Channel Webhook resource belongs to.

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

    • type string | null

      The type of webhook. Can be: webhook, studio, or trigger.

    • url string(uri) | null

      The absolute URL of the Channel Webhook resource.

    • configuration

      The JSON string that describes how the channel webhook is configured. The configuration object contains the url, method, filters, and retry_count values that are configured by the create and update actions.

    • 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.
POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks 
curl \
 --request POST 'https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Type=webhook&Configuration.Url=dummy&Configuration.Method=GET&Configuration.Filters=onMessageSent&Configuration.Filters=onChannelDestroyed&Configuration.RetryCount=2'
Request example 
{"Type"=>"webhook", "Configuration.Url"=>"dummy", "Configuration.Method"=>"GET", "Configuration.Filters"=>["onMessageSent", "onChannelDestroyed"], "Configuration.RetryCount"=>2}
Response examples (201) 
{
  "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "webhook",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2016-03-24T21:05:50Z",
  "date_updated": "2016-03-24T21:05:50Z",
  "configuration": {
    "url": "dummy",
    "method": "GET",
    "filters": [
      "onMessageSent",
      "onChannelDestroyed"
    ],
    "retry_count": 2
  }
}