curl --request POST \
--url https://pub-api.conversion.ai/api/v2/workflows/{workflowId}/trigger \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "jane@example.com",
"data": {
"form_id": "contact_us",
"page_url": "https://example.com/pricing",
"message": "Interested in enterprise plan"
}
}
'{
"data": {
"triggered": true
}
}Workflows
Trigger Workflow
Trigger an API-triggered workflow for a specific contact.
POST
/
v2
/
workflows
/
{workflowId}
/
trigger
curl --request POST \
--url https://pub-api.conversion.ai/api/v2/workflows/{workflowId}/trigger \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "jane@example.com",
"data": {
"form_id": "contact_us",
"page_url": "https://example.com/pricing",
"message": "Interested in enterprise plan"
}
}
'{
"data": {
"triggered": true
}
}Authorizations
Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.
Path Parameters
The ID of the workflow to trigger.
Body
application/json
The contact's email address. At least one of cnvContactId, userId, or email is required.
Example:
"jane@example.com"
The Conversion contact ID. At least one of cnvContactId, userId, or email is required.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
An external user identifier for the contact. At least one of cnvContactId, userId, or email is required.
Example:
"user_12345"
An optional map of custom data to pass to the workflow as trigger data.
Show child attributes
Show child attributes
Example:
{
"source": "backend",
"action": "onboarding_complete",
"plan": "pro",
"trial_days_remaining": 7
}
Response
Workflow triggered successfully.
Show child attributes
Show child attributes
Was this page helpful?