Get an integration
const url = 'https://api.getsitecontrol.com/v1/sites/1/integrations/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 \ --header 'Authorization: Bearer <token>'One integration with everything list_integrations gives except failures, plus its saved setup: the delay before sending, double opt-in, and what is sent where (mapping). Header values, fixed values and service credentials are not shown.
The setup is as saved now: not unsaved changes in the editor, and not what an older delivery was built from. A setting seen here is a thing to check, never the proven cause of a past failure. A deleted integration is still returned, with is_deleted: true.
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
Responses
Section titled “Responses”object
Integration id, the kind and a number, such as webhook:12
Service: a connected service such as Mailchimp or HubSpot; webhook: a request to a URL the site set up; zapier: a URL that Zapier or a similar automation platform subscribed.
Connected service, such as mailchimp; null for the other kinds
Name of the integration; null for webhook and zapier
List, audience or other place in the service the data goes to; null for webhook and zapier
Saved destination URL of a webhook or zapier; null for a service
Body format of a webhook: JSON or form-encoded; null otherwise
Widget whose responses it sends
object
Widget id, as in list_widgets
True: switched on now; false: switched off now. Says nothing about when it was switched
True: deleted; its id and delivery history stay readable
Seconds a delivery waits after it is created before it is first tried
True: the service asks the subscriber to confirm by email first; null when not set for this integration
What is sent where, as saved now; not what past deliveries used
object
False: the saved mapping could not be read, and the other fields say nothing about it
Fields filled from the response, at most 40
object
Where the value comes from, such as $form.<field> for a form field or $system.<name> for data recorded with the response (its id, page, location)
Field it is sent to at the destination
All mapping entries, of every type
Mapping entries not listed in fields, the counted types included
Fields set to a fixed value; values not shown
HTTP headers sent; values not shown
Conditions that decide whether to send at all
As in list_integrations: the last success ever; null when none
{ "kind": "service", "format": "json", "mapping": { "fields_total": 0, "fields_omitted": 0, "literal_fields": 0, "header_fields": 0, "condition_fields": 0 }}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
integration_not_found: no such integration on the site, or its 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