Create channel webhook

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

Path parameters

  • ServiceSid string Required

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

  • ChannelSid string Required
application/x-www-form-urlencoded

Body

  • Type string Required

    Values are webhook, trigger, or studio.

  • Configuration.Url string
  • Configuration.Method string

    Values are GET or POST.

  • Configuration.Filters array[string]
  • Configuration.Triggers array[string]
  • Configuration.FlowSid string

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

  • Configuration.RetryCount integer

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

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

    • account_sid string | null

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

    • service_sid string | null

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

    • channel_sid string | null

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

    • type string | null
    • url string(uri) | null
    • configuration
    • date_created string(date-time) | null
    • date_updated string(date-time) | null
POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks 
curl \
 --request POST 'https://ip-messaging.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://ip-messaging.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
  }
}