Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

List deliveries Beta

GET/api/v1/trigger-delivery/endpoints/{endpoint_id}/deliveries

This endpoint is in beta. Its request and response may change.

Lists the trigger events sent to one of your delivery endpoints, newest first, one entry per event however many attempts it took. Filter by status, by channel (a connection or subscription ID) and by time with after and before. Deliveries are kept for 90 days. Pass next_page_token as page_token to read older ones. The event's payload isn't returned.

Authorization

Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.

Path parameters

endpoint_idstringrequired
ID of your delivery endpoint (ep_...), the URL on your server that you added under Developers > Trigger Delivery. Look up a delivery returns it as endpoint_id on each attempt.

Query parameters

afterstring
Only deliveries of events created after this instant. Omit it to read back to the oldest retained delivery. Deliveries are kept for 90 days, so a value earlier than that is moved forward to the start of the retained window. Refused when later than before. Read to the second.
beforestring
Only deliveries of events created before this instant. Omit it to start from the newest delivery. A value later than the current time is treated as the current time. With after, reads a time range; the list stays newest first within it. Read to the second.
channelstring
Narrows the list to deliveries of events from one connection (a conn_ ID) or one trigger subscription (a trgs_ ID). The ID must exist in this environment; any other value is refused with 400. At most 64 characters.
page_sizeinteger
Maximum number of deliveries to return, newest first. Defaults to 20 when omitted or zero; a larger value than 100 is capped at 100 rather than refused.
page_tokenstring
The next_page_token from a previous response, to read the next page of older deliveries. Omit it to read the newest page. A token is bound to the environment, the endpoint and the filters it was issued with: a token sent with a different endpoint or different filters is refused rather than mixing two result sets. At most 1024 characters.
statusstring (enum)
Narrows the list to deliveries in this state. Omit it, or send TRIGGER_DELIVERY_STATUS_UNSPECIFIED, for every state. - TRIGGER_DELIVERY_STATUS_DELIVERED: An attempt succeeded. No further attempt is made. - TRIGGER_DELIVERY_STATUS_PENDING: Accepted for delivery; no attempt has finished yet. - TRIGGER_DELIVERY_STATUS_FAILED: Every scheduled attempt failed. No further attempt is made unless one is started by hand. - TRIGGER_DELIVERY_STATUS_RETRYING: An attempt failed and another is scheduled, at next_attempt_at.
TRIGGER_DELIVERY_STATUS_DELIVEREDTRIGGER_DELIVERY_STATUS_PENDINGTRIGGER_DELIVERY_STATUS_FAILEDTRIGGER_DELIVERY_STATUS_RETRYING

Response 200

deliveriesarray of object
One page of the endpoint's deliveries that match the filters, newest first.
Show 12 child attributes
connection_idstring
ID of the connection the event came from. Present even after the connection is deleted. Empty when the event carries none.
connection_key_idstring
Name of the connection the event came from, the value other AgentKit endpoints take as connector. Empty when the connection no longer exists.
connection_providerstring
Provider of the connection the event came from. Empty when the connection no longer exists.
endpoint_idstring
ID of the endpoint the event was delivered to.
event_idstring
Event ID of the event: the payload's dedupe_key and correlation_id. Empty when the event was sent without one.
message_timestampstring
When the event was accepted for delivery.
msg_idstring
Message ID of the event, sent to the endpoint as the webhook-id header.
next_attempt_atstring
When the next attempt is scheduled. Present only while status is TRIGGER_DELIVERY_STATUS_RETRYING.
statusstring (enum)
The delivery's state across all its attempts.
TRIGGER_DELIVERY_STATUS_DELIVEREDTRIGGER_DELIVERY_STATUS_PENDINGTRIGGER_DELIVERY_STATUS_FAILEDTRIGGER_DELIVERY_STATUS_RETRYING
subscription_idstring
ID of the trigger subscription that sent the event. Present even after the subscription is deleted. Empty when the event carries none.
trigger_modestring (enum)
How the trigger detects events, from the newest version of its definition: WEBHOOK or POLL. The trigger's mode now, not a record of how this one event was detected. TRIGGER_MODE_UNSPECIFIED when the subscription or the definition no longer exists.
WEBHOOKPOLL
trigger_namestring
Key of the trigger that fired, as the subscription was created with. Empty when the subscription no longer exists.
next_page_tokenstring
Pass this as page_token, with the same endpoint_id and filters, to read the next page of older deliveries. Empty when there are no older deliveries.

Errors

Every error has the same body: code, message and details. See Errors and rate limits.

400Invalid request - endpoint_id is missing, is longer than 256 characters, contains characters other than letters, digits, ., _ and -, or does not name a trigger delivery endpoint in this environment; status is not a known delivery status; channel is not a connection ID (conn_) or trigger subscription ID (trgs_) in this environment; after or before is not a valid timestamp, or after is later than before; or page_token is malformed or was issued for a different endpoint or set of filters
404Not found - Triggers isn't turned on for your environment
429Too many requests - deliveries are being read too often. Retry shortly; the request is not retried on your behalf
500Internal error - the deliveries could not be read; retry the request