Skip to main content
POST
/
journeys
/
{journeyId}
/
trigger
Trigger a journey entrance for one contact
curl --request POST \
  --url https://apix.spotzee.com/api/client/journeys/{journeyId}/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entrance_id": 2,
  "user": {
    "external_id": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "device_token": "<string>",
    "timezone": "<string>",
    "locale": "<string>"
  }
}
'
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

journeyId
integer | null

Numeric journey identifier.

Example:

33

Body

application/json

Manually trigger a journey entrance for a single contact.

entrance_id
integer
required

Identifier of the journey entrance step to enter the contact at.

Required range: x >= 1
user
object
required

Identifies the contact entering the journey.

event
object

Optional event payload available to journey conditions and template Handlebars as {{event}}.

Response

The trigger was queued.

Confirmation that the entrance was queued.

success
boolean
required