Skip to main content
GET
/
webhook-subscriptions
List all webhook subscriptions
curl --request GET \
  --url https://app.ezyshield.com.au/api/webhook-subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "url": "<string>",
        "events": [
          {}
        ],
        "secret": "<string>",
        "enabled": true,
        "consecutive_failures": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "disabled_at": "<string>"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

sort
string
default:-created_at

Available sorts are created_at, updated_at, consecutive_failures. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -created_at.

page[size]
integer
default:10

The number of results that will be returned per page.

page[number]
integer

The page number to start the pagination from.

fields[webhook-subscriptions]
enum<string>[]
Available options:
url,
events,
secret,
enabled,
consecutive_failures,
created_at,
updated_at,
disabled_at
filter[enabled]
boolean

Filter by whether the subscription is enabled.

Example:

true

Response

Paginated set of WebhookSubscriptionResource

data
WebhookSubscriptionResource · object[]
required
meta
object
required