Fetch a specific service webhook configuration.

GET /v1/Services/{ChatServiceSid}/Configuration/Webhooks
Account sid auth token

A service webhook configuration resource manages a service-level set of callback URLs and their configuration for receiving all the corresponding service events.

Fetch a specific service webhook configuration.

Path parameters

  • ChatServiceSid string Required

    The unique ID of the Conversation Service this conversation belongs to.

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

Responses

  • 200 application/json

    OK

    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
    • account_sid string | null

      The unique ID of the Account responsible for this service.

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

    • chat_service_sid string | null

      The unique ID of the Conversation Service this conversation belongs to.

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

    • pre_webhook_url string(uri) | null

      The absolute url the pre-event webhook request should be sent to.

    • post_webhook_url string(uri) | null

      The absolute url the post-event webhook request should be sent to.

    • filters array[string] | null

      The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are onParticipantAdd, onParticipantAdded, onDeliveryUpdated, onConversationUpdated, onConversationRemove, onParticipantRemove, onConversationUpdate, onMessageAdd, onMessageRemoved, onParticipantUpdated, onConversationAdded, onMessageAdded, onConversationAdd, onConversationRemoved, onParticipantUpdate, onMessageRemove, onMessageUpdated, onParticipantRemoved, onMessageUpdate or onConversationStateUpdated.

    • method string

      The HTTP method to be used when sending a webhook request. One of GET or POST.

      Values are GET or POST.

    • url string(uri) | null

      An absolute API resource URL for this webhook.
GET /v1/Services/{ChatServiceSid}/Configuration/Webhooks 
curl \
 --request GET 'https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Webhooks' \
 --user "username:password"
Response examples (200) 
{
  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks",
  "method": "POST",
  "filters": [
    "onMessageRemove",
    "onParticipantAdd"
  ],
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "pre_webhook_url": "https://www.example.com/pre",
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "post_webhook_url": "https://www.example.com/post"
}
{
  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks",
  "method": null,
  "filters": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "pre_webhook_url": null,
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "post_webhook_url": null
}