Api Reference
Webhook events
Inspect webhook events and retrieve the full payload that Vatly delivered.
The Webhook event API resource
A webhook event represents a single event delivery that Vatly generated. You can retrieve it later to inspect the exact payload that was sent.
Properties
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier for the webhook event. |
resource | string | The resource type. Always webhook_event. |
eventName | string | Event name that triggered the webhook, such as order.paid or subscription.updated. |
entityType | string | Resource type the event relates to, such as order, checkout, or subscription. |
entityId | string | ID of the resource this event relates to. |
object | object | Full resource payload as it existed when the event was created. |
links | object | HATEOAS links to related resources. Contains at least a self link. |
Get a webhook event
GET /v1/webhook-events/{eventId}
Retrieve the full webhook event payload for a specific event ID.
curl https://api.vatly.com/v1/webhook-events/evt_abc123def456 \
-H "Authorization: Bearer live_your_api_key_here"
$vatly = new \Vatly\API\VatlyApiClient();
$vatly->setApiKey('live_your_api_key_here');
$event = $vatly->webhookEvents->get('evt_abc123def456');
{
"id": "evt_abc123def456",
"resource": "webhook_event",
"eventName": "subscription.updated",
"entityType": "subscription",
"entityId": "sub_abc123def456",
"object": {
"id": "sub_abc123def456",
"resource": "subscription",
"customerId": "cus_xyz789",
"subscriptionPlanId": "subscription_plan_premium",
"testmode": false,
"name": "Premium Plan",
"description": "Access to all premium features",
"billingAddress": {
"fullName": "John Doe",
"companyName": null,
"vatNumber": null,
"streetAndNumber": "123 Main St",
"streetAdditional": null,
"city": "Amsterdam",
"region": null,
"postalCode": "1011AB",
"country": "NL"
},
"basePrice": {
"value": "99.99",
"currency": "EUR"
},
"quantity": 1,
"interval": "month",
"intervalCount": 1,
"status": "active",
"startedAt": "2026-01-15T10:30:00Z",
"endedAt": null,
"cancelledAt": null,
"renewedAt": "2026-02-15T10:30:00Z",
"renewedUntil": "2026-03-15T10:30:00Z",
"nextRenewalAt": "2026-03-15T10:30:00Z",
"trialUntil": null,
"links": {
"self": {
"href": "https://api.vatly.com/v1/subscriptions/sub_abc123def456",
"type": "application/json"
},
"customer": {
"href": "https://api.vatly.com/v1/customers/cus_xyz789",
"type": "application/json"
}
}
},
"links": {
"self": {
"href": "https://api.vatly.com/v1/webhook-events/evt_abc123def456",
"type": "application/json"
}
}
}
Response
Returns the full stored webhook event, including the resource snapshot in the object field.
Errors
| Status | Meaning |
|---|---|
401 | Missing or invalid API key |
403 | You do not have access to this event |
404 | The webhook event was not found |