Skip to main content
GET
/
webhook-subscriptions
/
{webhookSubscription}
/
webhook-events
List all webhook events for a subscription
curl --request GET \
  --url https://api.staging-2tid4c.ezyshield.com.au/verification/v1/webhook-subscriptions/{webhookSubscription}/webhook-events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "webhook-events",
      "attributes": {
        "status": "processing",
        "type": "verification.pending",
        "webhook_url": "<string>",
        "payload": [
          "<unknown>"
        ],
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "attempts": {
          "data": [
            {
              "type": "webhook-event-attempts",
              "id": "<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
  },
  "included": [
    {
      "id": "<string>",
      "type": "webhook-event-attempts",
      "attributes": {
        "status": "succeeded",
        "attempt": 123,
        "created_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

webhookSubscription
string<uuid>
required

The webhook subscription ID

Query Parameters

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.

filter[type]
enum<string>

Filter by event type.

Available options:
verification.pending,
verification.verified,
verification.rejected,
verification.failed,
verification.cancelled,
verification.expired,
verification.error,
verification.confirmation_ready,
verification.confirmation_notification_sent
filter[created_at_start]
string

Filter events created on or after this datetime.

filter[created_at_end]
string

Filter events created on or before this datetime.

Response

Paginated set of WebhookEventResource

data
WebhookEventResource · object[]
required
meta
object
required
included
WebhookEventAttemptResource · object[]