COconversion

Trigger Workflow

Trigger an API-triggered workflow for a specific contact.

post/v2/workflows/{workflowId}/trigger

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Path parameters

workflowIdstring uuid required

The ID of the workflow to trigger.

Request body

emailstring email

The contact's email address. At least one of cnvContactId, userId, or email is required.

cnvContactIdstring uuid

The Conversion contact ID. At least one of cnvContactId, userId, or email is required.

userIdstring

An external user identifier for the contact. At least one of cnvContactId, userId, or email is required.

dataobject

An optional map of custom data to pass to the workflow as trigger data.

Example request

{
  "email": "jane@example.com",
  "cnvContactId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "userId": "user_12345",
  "data": {
    "source": "backend",
    "action": "onboarding_complete",
    "plan": "pro",
    "trial_days_remaining": 7
  }
}

Response

Workflow triggered successfully.

Changes

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