Authenticate requests using the Workflows API credentials with the surveys.readonly scope to securely retrieve survey data.
Shape authenticates via OAuth with your GHL account, ensuring only approved scopes are granted (surveys.readonly by default).
GET /surveys/ — Retrieve list of surveys GET /surveys/submissions — Retrieve submissions for surveys
Trigger: When a new survey is created or updated in Workflows API, fetch and sync data to Shape.
Actions: call GET /surveys/, map fields (id, title, date_created) to Shape properties, create or update records.
GET /surveys/
id, title, date_created
Trigger: New submissions arrive for a survey; Shape pulls the latest responses.
Actions: fetch /surveys/submissions, map fields like respondent, responses, submitted_at to Shape records.
GET /surveys/submissions
submission_id, survey_id, respondent, submitted_at
Trigger: When a submission is received, enrich the corresponding contact in Shape.
N/A – uses endpoints above to enrich data
contact_id, survey_id, last_submission_date
Automate data flow without writing code
Access real-time survey data for decision-making
Centralize insights in Shape dashboards
Key elements include endpoints, authentication, triggers, actions, and data mapping. This guide explains each term and how they relate to the Shape integration.
A defined interface that allows software to interact, retrieve data, or trigger actions.
A URL path used to access a specific API function, such as GET /surveys/.
The process of verifying identity and permissions before allowing API access.
A callback URL that receives data in real time when events occur.
Automatically update contact properties based on survey answers to personalize outreach.
Set up automations to email or message respondents based on scores or answers.
Combine survey data with other metrics to visualize performance in Shape.
Provide Workflows API credentials and grant the surveys.readonly scope to Shape.
Enable GET /surveys/ and GET /surveys/submissions, map necessary fields to Shape properties.
Create triggers for new submissions and schedule periodic syncs.
No coding is required for the basic integration. Use the built-in connectors and mapping options to connect Shape with the Workflows API. If you need advanced data transformations, you can leverage conditional mapping and simple expressions. For more complex scenarios, consider incremental updates and staging to ensure data quality before triggering automations.
Typical synced fields include survey id, survey title, submission id, respondent, and timestamps. You can map these to Shape contact properties or custom fields to enable personalized automation. Additional fields from submissions can be pulled if needed, subject to API scope and permissions.
Submissions can be synced on a near real-time basis when triggers fire, or on a scheduled cadence. Real-time syncing depends on the availability of webhook triggers and the API’s rate limits. You can adjust frequency to balance freshness with API usage.
Yes. You can choose specific surveys to pull by filtering on survey_id or title. The mapping step lets you select which fields are imported, so you only bring in what you need for your workflows.
API calls are subject to the Workflows API’s rate limits. Plan your sync frequency and batch size accordingly to avoid hitting limits. If you anticipate high volume, implement pagination and incremental syncing.
Pushing data back to the Workflows API from Shape is not part of the default surveys.readonly scope. If write access is required, you would need the appropriate scopes and endpoints enabled by your API plan. Check your credentials before attempting writes.
To test, use a staging environment or a test survey. Enable logging of API responses, review mappings, and verify that connected Shape records update as expected. Run a dry run before activating live automations.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
