List deliveries Beta
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_idstringrequiredep_...), 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
afterstringbefore. Read to the second.beforestringafter, reads a time range; the list stays newest first within it. Read to the second.channelstringconn_ 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_sizeintegerpage_tokenstringstatusstring (enum)TRIGGER_DELIVERY_STATUS_DELIVEREDTRIGGER_DELIVERY_STATUS_PENDINGTRIGGER_DELIVERY_STATUS_FAILEDTRIGGER_DELIVERY_STATUS_RETRYINGscalekit_client.actions.triggers.list_deliveries
List trigger events sent to one of your endpoints, newest first.
scalekit_client.actions.triggers.list_deliveries( endpoint_id: str, page_size: int | None = None, page_token: str | None = None, status: TriggerDeliveryStatus | str | int | None = None, channel: str | None = None, after: datetime | None = None, before: datetime | None = None,) -> ListTriggerDeliveriesByEndpointResponseParameters
endpoint_idstrrequiredep_...), the URL on your server that you added under Developers > Trigger Delivery. Look up a delivery returns it as endpoint_id on each attempt.page_sizeint | Nonepage_tokenstr | Nonenext_page_token of a previous page (with the same filters).statusTriggerDeliveryStatus | str | int | Nonechannelstr | Noneconn_...) or subscription (trgs_...).afterdatetime | Nonebeforedatetime | NoneReturns ListTriggerDeliveriesByEndpointResponse: One page of messages and next_page_token.
From scalekit-sdk-python 2.23.0.
Response 200
deliveriesarray of objectShow 12 child attributes
connection_idstringconnection_key_idstringconnector. Empty when the connection no longer exists.connection_providerstringendpoint_idstringevent_idstringdedupe_key and correlation_id. Empty when the event was sent without one.message_timestampstringmsg_idstringwebhook-id header.next_attempt_atstringstatusstring (enum)TRIGGER_DELIVERY_STATUS_DELIVEREDTRIGGER_DELIVERY_STATUS_PENDINGTRIGGER_DELIVERY_STATUS_FAILEDTRIGGER_DELIVERY_STATUS_RETRYINGsubscription_idstringtrigger_modestring (enum)WEBHOOKPOLLtrigger_namestringnext_page_tokenstringErrors
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 filters404Not found - Triggers isn't turned on for your environment429Too many requests - deliveries are being read too often. Retry shortly; the request is not retried on your behalf500Internal error - the deliveries could not be read; retry the request