Skip to main content
GET
/
webhook-subscriptions
/
{webhookSubscription}
/
webhook-events
/
{webhookEvent}
Get a webhook event
curl --request GET \
  --url https://api.staging-2tid4c.ezyshield.com.au/verification/v1/webhook-subscriptions/{webhookSubscription}/webhook-events/{webhookEvent} \
  --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>"
          }
        ]
      }
    }
  },
  "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

webhookEvent
string<uuid>
required

The webhook event ID

Response

WebhookEventResource

data
WebhookEventResource · object
required
included
WebhookEventAttemptResource · object[]