Skip to content
PayloadPuffin.
Join the waitlist

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

  • status string Optional

    Filter by state.

    Allowed values: "pending", "held", "delivering", "retrying", "delivered", "failed"

  • eventId string Optional

    An event ID, starting with evt_.

  • destinationId string Optional

    A destination ID, starting with dst_.

  • limit number Optional

    Items to return. Defaults to 100.

    1 to 100

  • cursor string Optional

    Continue before this delivery ID.

Returns

200

The query result.

  • data object[] Required

    Deliveries in this page.

    • id string Required

      A delivery ID, starting with dlv_.

    • eventId string Required

      An event ID, starting with evt_.

    • destination object Required

      The destination this delivery is sent to.

      Show child attributesHide child attributes
      • id string Required

        A destination ID, starting with dst_.

      • name string | null Required

        The destination name, or its last name when it was deleted. Null only for a destination deleted before names were kept.

      • deleted boolean Required

        True when the destination has been deleted.

    • status string 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"

    • attemptCount number Required

      Attempts recorded so far. Retrying stops at 8; a resend adds one more without resetting this, so it can exceed 8.

    • nextAttemptAt string | null Required

      When the next attempt is scheduled. Null when nothing is scheduled, including held and settled deliveries.

    • error string | null Required

      Why the last attempt did not succeed, from either side. Null until one fails or after success.

    • acceptedAt string (date-time) Required

      ISO 8601 timestamp.

    • firstAttemptAt string | null Required

      When the first attempt started. Null until one does.

    • completedAt string | null Required

      When the delivery settled. Null while still live.

  • links object Required

    Links for navigating a paginated collection.

    • next string | null Required

      URI reference for the next page, or null at the end.

Example

Request
curl -X GET "https://api.payloadpuffin.com/v1/deliveries" \
  -H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"
Response 200
{
  "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.

  • 4XX application/problem+json

    The request was rejected.