Choose your integration
These workflows use the REST API from your backend or scheduler. For an interactive investigation, you can also connect an AI assistant through MCP.
Send new leads to your CRM
Section titled “Send new leads to your CRM”Use event subscriptions to forward response.created or contact.created events to your receiver. This lets you connect a CRM or email platform even when Getsitecontrol has no native integration for it.
- Check the available payloads with List event types.
- Create a subscription with your destination URL, headers, and body template.
- Test the subscription and inspect its delivery records before relying on it.
Make your receiver tolerate repeated deliveries. A receiving service may require its own authentication and field mapping.
Add contacts from your backend
Section titled “Add contacts from your backend”When someone signs up in your app, create or update the contact by email; the response is the contact. To sync a list from another system, create or update contacts in batches of up to 100; the response reports each item. Send the fields your workflow needs, keyed by field ID, and tags by name.
A new contact is subscribed unless you send status: unsubscribed, and a subscribed new contact starts your “new contact” automations. Only subscribe contacts who have given the necessary consent. For an existing contact, leave status out to keep what the contact chose, or send it to keep an unsubscribe in sync.
To start an email workflow for a contact, use Run an automation for a contact. It runs only automations with the automation_start trigger that are on; automations triggered by a new contact start on their own.
Use an idempotency key for POST requests that your integration may retry.
Build a daily popup report
Section titled “Build a daily popup report”Pull widget performance into a spreadsheet or your own dashboard:
- List your sites and choose a site ID.
- Retrieve statistics per widget to compare popups.
- Retrieve the statistics timeline for daily trends.
- Write the results to your reporting destination using its API.
Set the reporting period explicitly and read the endpoint’s metric definitions before combining results. A rate is null, not zero, when a widget had no shows, and without widget_ids the per-widget list leaves out widgets without events. Connecting the destination and scheduling the job are part of your integration.
Audit your popup settings
Section titled “Audit your popup settings”List widgets and read their settings to build a registry of popups, statuses, and targeting rules. Your script can filter that registry, for example to find widgets shown on a particular URL.
Follow pagination to include every widget, especially on sites with large popup libraries. Targeting comes whole in the list. Check targeting.is_complete: when it is false, some rules could not be read, and warnings says which. Other nested lists and texts can be shortened; truncated names them, and Get a widget returns them whole.
Export form responses
Section titled “Export form responses”Retrieve responses across widgets or responses from one widget. The response data includes submitted values and visitor context such as UTM parameters, where available.
Follow the returned cursors to collect all pages, then write the records to your own CSV, database, or daily digest. The API returns JSON; your integration produces the file or email. Responses awaiting double opt-in or email checks can appear later with their original IDs and timestamps, so a cursor or created_since alone can miss them. For an incremental export, re-read a time window with a margin and merge records by id.
Investigate a failed sync
Section titled “Investigate a failed sync”If a contact did not reach a connected service, start with List integration deliveries. Inspect an individual delivery record for details about the failure.
Use these records to identify an authentication, field-mapping, or destination error. The API reads integrations but does not change them: reconnect a native integration or fix its mapping in the Getsitecontrol dashboard.
Use the browser JavaScript API
Section titled “Use the browser JavaScript API”To control widget display or pass visitor context on your website, use the JavaScript API. Those browser actions are separate from the server-side workflows above.