Skip to content
PayloadPuffin.
Join the waitlist

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

  • eventId string Required

    An event ID, starting with evt_.

Returns

200

The query result.

  • data object Required

    One accepted event and the deliveries it fanned out to.

    • id string Required

      An event ID, starting with evt_.

    • type string Required

      The event type it was sent with.

    • payloadSize number Required

      Size of the stored payload in bytes.

    • contentType string Required

      Content type the payload was stored with.

    • receivedAt string (date-time) Required

      ISO 8601 timestamp.

    • channels string[] Required

      Channels the event was addressed to, sorted and without duplicates. Empty when it named none, in which case it reached only destinations without channels.

    • sender string Required

      Who 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.

    • unbuiltReason string | null Required

      Why 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.

    • deliveries object[] Required

      Every delivery this event fanned out to, oldest first. Its attempts come from GET /v1/deliveries/{deliveryId}.

      Show child attributesHide child attributes
      • 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.

Example

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

  • 4XX application/problem+json

    The request was rejected.