workflows

Trigger workflow

Trigger a specific workflow for a contact. The workflow must have triggerType 'api' and be enabled.

post/v1/workflows/{workflowId}/trigger

Request

  • Base URL: https://api.wraps.dev
  • URL: https://api.wraps.dev/v1/workflows/{workflowId}/trigger
  • Auth: HTTP bearer

Path parameters

workflowIdstring required

Workflow ID to trigger

Request body

contactIdstring

Contact ID

contactEmailstring

Contact email (alternative to contactId)

dataobject

Data to pass to the workflow

Response

successboolean required
messagestring
workflowIdstring
workflowNamestring
contactIdstring
errorstring

Changes

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