List webhook subscriptions

Examples

Let's establish some of our data that will be used in the following example:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• Organization ID: 823fbfaf-f14e-4693-b55a-8ec1c17d649e

• AccessKey: abcd

Request

curl -X GET "https://api.bird.com/organizations/823fbfaf-f14e-4693-b55a-8ec1c17d649e/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/webhook-subscriptions" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)

{
  "nextPageToken": "WyJvcmdhbml6YXRpb25zI2ZmMWE1OTQ5LWE3MDQtNDhkMi05OWQ5LWIyY2RmYjdmZWYzZSN3b3Jrc3BhY2VzI2IyZDdhMDEzLTg2ZGYtNGFhNy04MjQ1LThmMzcxNWM4N2FlMiN3ZWJob29rLXN1YnNjcmlwdGlvbnMiLCJ3ZWJob29rLXN1YnNjcmlwdGlvbiNhNWMzOWE1Mi0wMDViLTQwOWUtOTM3ZC0yNzE3YzkxODk3OWMiLCJvcmdhbml6YXRpb25zI2ZmMWE1OTQ5LWE3MDQtNDhkMi05OWQ5LWIyY2RmYjdmZWYzZSN3b3Jrc3BhY2VzI2IyZDdhMDEzLTg2ZGYtNGFhNy04MjQ1LThmMzcxNWM4N2FlMiN3ZWJob29rLXN1YnNjcmlwdGlvbnMiLCJ3ZWJob29rLXN1YnNjcmlwdGlvbiNhNWMzOWE1Mi0wMDViLTQwOWUtOTM3ZC0yNzE3YzkxODk3OWMiXQ==",
  "results": [
    {
      "id": "b02e99b2-dc38-4e2d-b349-d9e1fd772c44",
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "service": "payments",
      "event": "intent",
      "template": "",
      "url": "https://www.test.com",
      "status": "active",
      "createdAt": "2024-09-30T12:31:36.106613753Z",
      "updatedAt": "2024-09-30T12:31:36.106613843Z"
    },
    {
      "id": "a5c39a52-005b-409e-937d-2717c918979c",
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "service": "channels",
      "event": "whatsapp.interaction",
      "eventFilters": [
        {
          "key": "channelId",
          "value": "f788aecc-4886-5ee9-b392-de28bc2fd063"
        },
        {
          "key": "interactionType",
          "value": "read"
        }
      ],
      "template": "",
      "url": "https://webhook.site/68be485e-5faa-4363-8033-2e3d236830db",
      "status": "active",
      "createdAt": "2024-11-21T10:44:38.824639879Z",
      "updatedAt": "2024-11-21T10:44:38.824640035Z"
    }
  ]

Note: if you have more than 10 webhook subscriptions, the results may be paginated. To know more about how to use the nextPageToken to get the following results, refer to this pagination documentation.