GEgetsitecontrol
Integrations

Get an integration

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.

get/v1/sites/{site_id}/integrations/{integration_id}

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required
integration_idstring required

Integration id from list_integrations, such as webhook:12

Response

Successful Response

idstring required

Integration id, the kind and a number, such as webhook:12

kind'service' | 'webhook' | 'zapier' required

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.

servicestring nullable

Connected service, such as mailchimp; null for the other kinds

namestring nullable

Name of the integration; null for webhook and zapier

target_namestring nullable

List, audience or other place in the service the data goes to; null for webhook and zapier

urlstring nullable

Saved destination URL of a webhook or zapier; null for a service

format'json' | 'form' nullable

Body format of a webhook: JSON or form-encoded; null otherwise

is_activeboolean required

true: switched on now; false: switched off now. Says nothing about when it was switched

created_atstring date-time nullable
updated_atstring date-time nullable
is_deletedboolean required

true: deleted; its id and delivery history stay readable

delay_secondsinteger nullable

Seconds a delivery waits after it is created before it is first tried

double_opt_inboolean nullable

true: the service asks the subscriber to confirm by email first; null when not set for this integration

last_succeeded_atstring date-time nullable

As in list_integrations: the last success ever; null when none

Changes

No recorded changes to this operation across all 1 revision of this API.