Retrieve a list of all Webhooks for a Service

GET /v2/Services/{ServiceSid}/Webhooks

TODO: Resource-level docs

Retrieve a list of all Webhooks for a Service.

Path parameters

  • ServiceSid string Required

    The unique SID identifier of the Service.

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • webhooks array[object]
      Hide webhooks attributes Show webhooks attributes
      • account_sid string | null

        The SID of the Account that created the resource

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

      • date_created string(date-time) | null

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

      • date_updated string(date-time) | null

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

      • event_types array[string] | null

        The array of events that this Webhook is subscribed to.

      • friendly_name string | null

        The string that you assigned to describe the webhook

      • service_sid string | null

        Service Sid.

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

      • sid string | null

        The unique string that identifies the resource

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

      • status string | null

        The webhook status

        Values are enabled or disabled.

      • url string(uri) | null

        The absolute URL of the Webhook resource

      • version string | null

        The webhook version

        Values are v1 or v2.

      • webhook_method string | null

        The method used when calling the webhook's URL.

        Values are GET or POST.

      • webhook_url string(uri) | null

        The URL associated with this Webhook.
GET /v2/Services/{ServiceSid}/Webhooks 
curl \
 -X GET https://verify.twilio.com/v2/Services/{ServiceSid}/Webhooks \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "webhooks": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "event_types": [
        "string"
      ],
      "friendly_name": "string",
      "service_sid": "string",
      "sid": "string",
      "status": "enabled",
      "url": "https://example.com",
      "version": "v1",
      "webhook_method": "GET",
      "webhook_url": "https://example.com"
    }
  ]
}