Skip to content
PayloadPuffin.
Join the waitlist

List destinations

GET/v1/destinationspreview

List every destination deliveries are sent to. Signing secrets are never returned.

Returns

200

The query result.

  • data object[] Required

    Every destination, newest first.

    • id string Required

      A destination ID, starting with dst_.

    • name string Required

      Human-readable label for the destination.

    • url string (uri) Required

      Where the request is sent.

    • enabled boolean Required

      A disabled destination receives no new deliveries; deliveries already created still run. The only way to receive nothing.

    • health string Required

      One label for whether this destination needs attention. suspended: the circuit is open or probing, or it is paused for failing. unused: nothing was ever accepted. failing: a failure is counted since the last success, or the 24h success rate is below 50%. idle: deliveries exist but none settled in 24h. healthy otherwise.

      Allowed values: "healthy", "failing", "idle", "unused", "suspended"

    • eventTypes string[] Required

      Event types this destination receives, matched exactly. Empty receives every type; otherwise the event type must be one of them. Stored sorted, without duplicates.

      At most 100 items

    • channels string[] Required

      Channels this destination receives. Empty receives every event, with or without channels. Otherwise the event must name at least one of them, so an event that names no channel never reaches it. Stored sorted, without duplicates.

      At most 100 items

    • lastDeliveryAt string | null Required

      Acceptance time of the most recent delivery to this destination. Null when there is none.

    • pausedAt string | null Required

      When the destination was paused for failing. Null while it is not paused.

  • 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/destinations" \
  -H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"
Response 200
{
  "data": [
    {
      "id": "id",
      "name": "name",
      "url": "url",
      "enabled": true,
      "health": "healthy",
      "eventTypes": [
        "eventTypes"
      ],
      "channels": [
        "channels"
      ],
      "lastDeliveryAt": "lastDeliveryAt",
      "pausedAt": "pausedAt"
    }
  ],
  "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.