GET
/
api
/
v2
/
platform
/
webhooks
/
subscribers
Return a list of Webhook Subscribers
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/webhooks/subscribers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "5",
      "type": "subscriber",
      "attributes": {
        "url": "https://www.url5.com/",
        "active": true,
        "subscriptions": [
          "*"
        ],
        "created_at": "2022-11-08T19:35:58.830Z",
        "updated_at": "2022-11-08T19:35:58.830Z"
      }
    },
    {
      "id": "6",
      "type": "subscriber",
      "attributes": {
        "url": "https://www.url6.com/",
        "active": true,
        "subscriptions": [
          "*"
        ],
        "created_at": "2022-11-08T19:35:58.831Z",
        "updated_at": "2022-11-08T19:35:58.831Z"
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/webhooks/subscribers?page=1&per_page=&filter[active_eq]=&filter[url_cont]=",
    "next": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
filter[active_eq]
string
​
filter[url_cont]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.