Skip to main content

Create Workflow Trigger

POST 

/api/v1/workflow-builder/workflows/:workflow_id/triggers

Add a trigger to a workflow.

Trigger Types:

  • event: Fires on applicant/document/screening events

    \{"type": "event", "event": "applicant.created", "config": \{"filter": \{"country": "US"\}\}\}
  • schedule: Fires on a time schedule

    \{"type": "schedule", "config": \{"schedule": \{"type": "daily", "hour": 2\}\}\}
  • threshold: Fires when conditions are met

    \{"type": "threshold", "config": \{"threshold": \{"risk_score_above": 80\}\}\}
  • webhook: Fires on incoming webhook (returns a URL)

    \{"type": "webhook", "config": \{"secret": "optional-hmac-secret"\}\}

Request

Responses

Successful Response