Trigger automations

An automation with entry trigger API exposes an authored apiKey. Your backend can enter a profile and attach JSON context consumed by workflow conditions, messages, or webhooks.

Request

POST /api/v1/environments/{environmentId}/automations/{automationApiKey}/trigger
Authorization: Bearer engk_…
Content-Type: application/json

{
  "profileId": "019c0c2e-…",
  "context": {
    "source": "checkout",
    "cart_id": "cart_42",
    "cart_value": 149.9
  }
}

curl --request POST \
  "$ENGAGE_BASE_URL/api/v1/environments/$ENGAGE_ENVIRONMENT_ID/automations/cart_recovery/trigger" \
  --header "Authorization: Bearer $ENGAGE_ACCESS_KEY" \
  --header "Content-Type: application/json" \
  --data '{"profileId":"PROFILE_ID","context":{"cart_id":"cart_42"}}'

Response

{
  "accepted": true,
  "runId": "019c…",
  "enteredAt": "2026-08-18T10:00:00Z"
}

The automation must be active, use an API entry trigger with the matching key, and target at least one app allowed by the access key. Audience and re-entry policy are evaluated before creating the run.

Context safety

Context is workflow input, not a profile update. Keep it bounded and non-sensitive. Use an explicit UPDATE_PROFILE step when the workflow should persist a profile field.

Workflow execution

Runs are durable. Wait steps schedule future work; workers claim due runs with retry-safe state. Push, in-app, webhook, profile-update, condition, and exit steps produce per-step execution status for diagnostics and analytics.