Skip to main content
POST
Start a new journey

Authorizations

Authorization
string
header
required

Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start

Headers

x-gbg-scenario
string

Applies a saved test scenario for this journey, selected by name (see /test/journeys/{journeyId}/scenarios). The start response then carries test: true and scenario: <name>. The value inline instead takes the scenario from the request body scenario field.

Example:

"my-scenario"

Body

application/json
resourceId
string
required
Minimum string length: 1
Pattern: ^[a-zA-Z0-9_-]+(@[a-zA-Z0-9_.-]+)?$
context
object
required
scenario
object

Response

Journey started

instanceId
string
required
status
enum<string>
required
Available options:
started,
completed,
failed,
awaiting-input,
pending
instanceUrl
string
message
string
state
object
test
boolean

Present and true only when the journey was started as a test scenario.

scenario
string

The test scenario that was applied: its name, or "inline" for a scenario supplied in the request body. Present only together with test: true.

Example:

"inline"