Get an integration delivery
const url = 'https://api.getsitecontrol.com/v1/sites/1/integrations/example/deliveries/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.getsitecontrol.com/v1/sites/1/integrations/example/deliveries/example \ --header 'Authorization: Bearer <token>'One delivery record of the integration, read now: the same fields as an item of list_integration_deliveries, with the same meaning. Call it with an id from that list to see whether a pending delivery has finished, or to re-read one record without its time window. To find the deliveries of a form response, use list_integration_deliveries with response_id.
Not bound to the 31-day window of the list: a record still kept is returned whatever its age. Its status is current; the integration’s settings now do not explain an older record.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Integration id from list_integrations, such as webhook:12
Integration id from list_integrations, such as webhook:12
Delivery id: id of an item of list_integration_deliveries, such as webhook_delivery:99
Delivery id: id of an item of list_integration_deliveries, such as webhook_delivery:99
Responses
Section titled “Responses”object
Opaque id, unique within this integration; do not parse
Current status of a delivery. pending: queued, set aside or being sent,
not finished, with no promised retry time; succeeded: finished without an
error, which does not prove that a request was sent or that the destination
kept the data; failed: stopped with an error, which does not prove that
nothing arrived; cancelled: dropped by our side before sending, see
reason; it does not prove that nothing was sent earlier.
What a succeeded or failed record proves about the send, read from its own status, status_code and reason; settings as they are now are not consulted. null while pending and when cancelled. A finished record is final: the sender does not try it again, a new form response is the way to send again. Not the vocabulary of an attempt’s outcome, which describes one HTTP request
Recorded attempts; the sender may reset this counter, so it is not a count of HTTP requests
Id of the form response the delivery carries; null when there is none or the response was deleted
HTTP status the destination last answered with, 100 to 599; null without an HTTP answer
Our own outcome, when there is one: empty_url the URL came out empty and conditions_failed the mapping conditions were not met, both with nothing sent, even under status succeeded; targeting_not_matched, cooldown, empty_input_data, skipped, cancelled (with status cancelled), no_response_recorded (no answer was stored). Vocabulary may grow
Stored text of the outcome: the destination’s answer or our error, cut to 1000 characters; null when succeeded
When the delivery was created; lists and statistics select by it
Last time the record was written; not when a request finished
HTTP requests in order. Null: no per-attempt history was kept, as for every service and older webhook records; it does not mean nothing was sent. Empty: not tried yet
object
1 for the first request of a delivery
How long the request took; null when unknown
How this one request ended: accepted, retryable, rate_limited, rejected, gone or unknown; vocabulary may grow. Not the vocabulary of the delivery’s outcome, which is the evidence of the whole record
HTTP status the destination answered with
The destination’s Location header, as stored; redirects are not followed
Short error text of the request, when it recorded one
{ "status": "pending", "outcome": "accepted_by_destination"}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
Authentication scheme: Bearer
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
delivery_not_found: no delivery with this id in this integration, or the integration is not on the site. integration_not_found: the integration’s widget is deleted
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
Seconds until the bucket refills
temporarily_unavailable: the delivery records could not be read in time, or limits cannot be enforced; retry later
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds