Journeys

Preview a contact's journey step path without sending

POST/v1/journeys/{id}/simulate

Requires an API key with the journeys:read scope. About keys and scopes

Previews a run without sending. entry says whether the contact would enter now: a date journey needs a valid date in its field; an event journey checks the supplied eventProperties against the entry conditions, then reentry. The path follows branches on eventProperties and filters and splits on the contact as they are now; a wait-until step takes its match path. Each send step is checked against suppression, consent, topics and devices: would_send, unreachable (takes the fallback path) or would_skip, with the refusal code in reason (DRAFT_INCOMPLETE for a send step not yet finished: a draft simulates too). Message limits and send-time scheduling are not previewed.

Path parameters

idstringrequired: uuid

Request body

contactIdstringrequired

The contact to simulate.

uuid

eventPropertiesobjectoptional

Properties of a trigger event to simulate, checked against entry conditions.

default {}

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

contactIdstringrequired

uuid

entryobjectrequired

Whether the contact would enter the journey now.

2 child attributes

eligiblebooleanrequired: Whether the contact would enter now.
reasonstring | nullrequired: Why not: no_date, entry_conditions_not_met, already_enrolled or in_cooldown.

pathobject[]required

The steps the contact would pass through, in order.

4 child attributes

stepIndexintegerrequired

Index of the step in steps.

min -9007199254740991 · max 9007199254740991

typestringrequired

The step type.

outcomestringrequired

What the step would do.

reasonstringoptional

Why a send step would not send: the send guard's error code.

curl -X POST https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/simulate \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
  }'

const response = await fetch('https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/simulate', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/simulate",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/simulate", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
    "entry": {
      "eligible": true,
      "reason": "reason_example"
    },
    "path": [
      {
        "stepIndex": -9007199254740991,
        "type": "type_example",
        "outcome": "outcome_example"
      }
    ]
  }
}

Example values are generated from the schema.