← Back to docs

Triggers

Triggers start workflows when events occur in connected systems or when data is sent directly to SyncToScale.

POST Send events to trigger workflows

Event-based triggers

Event triggers allow external systems to notify SyncToScale when something happens, such as a new hire being created or a record updated. 

POST /triggers/event
{
  "provider": "bamboohr",
  "event_type": "employee.created",
  "payload": {
    "id": "9981",
    "email": "newhire@example.com"
  }
}

Trigger responses

Successful trigger requests return a queued response indicating that a workflow run has been created. 

{
  "status": "queued",
  "workflow": "sync_to_hr",
  "triggered_at": "2025-01-20T14:12:00Z"
}

Idempotency

To prevent duplicate runs, triggers can be sent with a consistent external identifier. SyncToScale will ignore repeat events with the same identifier.