List deliveries
GET/v1/deliveriespreview
List deliveries newest first. Filter by status to find the ones waiting on you: “held” for events that arrived too late to deliver, or “failed” for deliveries that ran out of retries.
Query parameters
statusstring OptionalFilter by state.
Allowed values: "pending", "held", "delivering", "retrying", "delivered", "failed"
eventIdstring OptionalAn event ID, starting with evt_.
destinationIdstring OptionalA destination ID, starting with dst_.
limitnumber OptionalItems to return. Defaults to 100.
1 to 100
cursorstring OptionalContinue before this delivery ID.
Returns
The query result.200
dataobject[] RequiredDeliveries in this page.
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.
linksobject RequiredLinks for navigating a paginated collection.
nextstring | null RequiredURI reference for the next page, or null at the end.
Example
curl -X GET "https://api.payloadpuffin.com/v1/deliveries" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"{
"data": [
{
"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"
}
],
"links": {
"next": "next"
}
}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.