Sign in

v1

latestOpenAPI 3.0.02026-07-131658213.4 KB
Webhooks

Get single change event

Retrieve detailed information for a specific change event. Free API - does not count towards usage quota.

get/v2/webhooks/subscriptions/{requestId}/changes/{changeId}

Path parameters

requestIdstring required
Example:req_abc123xyz

requestId received during webhook registration

changeIdstring required
Example:change_def456

Change event ID

Response

Change event retrieved successfully

eventIdstring required
requestIdstring required
webhookUrlstring required
event'status.changed' | 'status.delivered' | 'first.tracked' | 'tracking.completed' | 'tracking.failed' | 'bulk.completed' required
status'delivered' | 'failed' | 'pending' required
deliveryAttemptsnumber required
maxAttemptsnumber required
nextRetryAtstring
lastErrorstring
createdAtstring required
updatedAtstring required