List destinations
GET/v1/destinationspreview
List every destination deliveries are sent to. Signing secrets are never returned.
Returns
The query result.200
dataobject[] RequiredEvery destination, newest first.
idstring RequiredA destination ID, starting with dst_.
namestring RequiredHuman-readable label for the destination.
urlstring (uri) RequiredWhere the request is sent.
enabledboolean RequiredA disabled destination receives no new deliveries; deliveries already created still run. The only way to receive nothing.
healthstring RequiredOne 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"
eventTypesstring[] RequiredEvent 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
channelsstring[] RequiredChannels 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
lastDeliveryAtstring | null RequiredAcceptance time of the most recent delivery to this destination. Null when there is none.
pausedAtstring | null RequiredWhen the destination was paused for failing. Null while it is not paused.
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/destinations" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"{
"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.
4XXapplication/problem+jsonThe request was rejected.