Skip to main content
POST
/
api
/
v1
/
journeys
/
{journeyKey}
/
trigger
Trigger journey
curl --request POST \
  --url http://localhost:3001/api/v1/journeys/{journeyKey}/trigger \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "profile": {
    "email": "jsmith@example.com",
    "externalId": "<string>",
    "userId": "<string>",
    "anonymousId": "<string>",
    "properties": {}
  },
  "variables": {}
}
'
{
  "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Headers

idempotency-key
string
required

Required idempotency key. Reusing it with the same resolved journey/profile/variables replays the original trigger response.

Required string length: 1 - 255

Path Parameters

journeyKey
string
required

Stable developer key for the Journey.

Required string length: 1 - 120

Body

application/json
profile
object
required
variables
object

Response

Default Response

runId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
exited