Get an event
GET/v1/events/{eventId}preview
Fetch one accepted event together with every delivery it fanned out to. A delivery’s attempts come from Get a delivery.
Path parameters
eventIdstring RequiredAn event ID, starting with evt_.
Returns
The query result.200
dataobject RequiredOne accepted event and the deliveries it fanned out to.
idstring RequiredAn event ID, starting with evt_.
typestring RequiredThe event type it was sent with.
payloadSizenumber RequiredSize of the stored payload in bytes.
contentTypestring RequiredContent type the payload was stored with.
receivedAtstring (date-time) RequiredISO 8601 timestamp.
channelsstring[] RequiredChannels the event was addressed to, sorted and without duplicates. Empty when it named none, in which case it reached only destinations without channels.
senderstring RequiredWho sent the event, by ID: the source (src_) whose URL received it, the API key (apk_) that sent it with POST /v1/events, or the user (usr_) who sent it from the console.
unbuiltReasonstring | null RequiredWhy the source couldn’t build this event, such as the error its transform threw. Present exactly when the event is unbuilt: fix the source’s transform, then rerun the event.
deliveriesobject[] RequiredEvery delivery this event fanned out to, oldest first. Its attempts come from GET /v1/deliveries/{deliveryId}.
Show child attributesHide child attributes
idstring RequiredA delivery ID, starting with dlv_.
eventIdstring RequiredAn event ID, starting with evt_.
destinationobject RequiredThe destination this delivery is sent to.
Show child attributesHide child attributes
idstring RequiredA destination ID, starting with dst_.
namestring | null RequiredThe destination name, or its last name when it was deleted. Null only for a destination deleted before names were kept.
deletedboolean RequiredTrue when the destination has been deleted.
statusstring Required“held”: the event arrived too late to deliver, and the delivery waits for you to resend it. “pending”: not attempted yet.
Allowed values: "pending", "held", "delivering", "retrying", "delivered", "failed"
attemptCountnumber RequiredAttempts recorded so far. Retrying stops at 8; a resend adds one more without resetting this, so it can exceed 8.
nextAttemptAtstring | null RequiredWhen the next attempt is scheduled. Null when nothing is scheduled, including held and settled deliveries.
errorstring | null RequiredWhy the last attempt did not succeed, from either side. Null until one fails or after success.
acceptedAtstring (date-time) RequiredISO 8601 timestamp.
firstAttemptAtstring | null RequiredWhen the first attempt started. Null until one does.
completedAtstring | null RequiredWhen the delivery settled. Null while still live.
Example
curl -X GET "https://api.payloadpuffin.com/v1/events/$EVENTID" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"{
"data": {
"id": "id",
"type": "type",
"payloadSize": 0,
"contentType": "contentType",
"receivedAt": "receivedAt",
"channels": [
"channels"
],
"sender": "sender",
"unbuiltReason": "unbuiltReason",
"deliveries": [
{
"id": "id",
"eventId": "eventId",
"destination": {
"id": "id",
"name": "name",
"deleted": true
},
"status": "pending",
"attemptCount": 0,
"nextAttemptAt": "nextAttemptAt",
"error": "error",
"acceptedAt": "acceptedAt",
"firstAttemptAt": "firstAttemptAt",
"completedAt": "completedAt"
}
]
}
}Errors
Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.
4XXapplication/problem+jsonThe request was rejected.