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": {}
}
'import requests
url = "http://localhost:3001/api/v1/journeys/{journeyKey}/trigger"
payload = {
"profile": {
"email": "jsmith@example.com",
"externalId": "<string>",
"userId": "<string>",
"anonymousId": "<string>",
"properties": {}
},
"variables": {}
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
profile: {
email: 'jsmith@example.com',
externalId: '<string>',
userId: '<string>',
anonymousId: '<string>',
properties: {}
},
variables: {}
})
};
fetch('http://localhost:3001/api/v1/journeys/{journeyKey}/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/journeys/{journeyKey}/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'profile' => [
'email' => 'jsmith@example.com',
'externalId' => '<string>',
'userId' => '<string>',
'anonymousId' => '<string>',
'properties' => [
]
],
'variables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/journeys/{journeyKey}/trigger"
payload := strings.NewReader("{\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"userId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"properties\": {}\n },\n \"variables\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/api/v1/journeys/{journeyKey}/trigger")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"userId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"properties\": {}\n },\n \"variables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/journeys/{journeyKey}/trigger")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"userId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"properties\": {}\n },\n \"variables\": {}\n}"
response = http.request(request)
puts response.read_body{
"runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Journeys
Trigger journey
Trigger one active API-triggerable Journey by stable developer key and return a JourneyRun status handle.
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": {}
}
'import requests
url = "http://localhost:3001/api/v1/journeys/{journeyKey}/trigger"
payload = {
"profile": {
"email": "jsmith@example.com",
"externalId": "<string>",
"userId": "<string>",
"anonymousId": "<string>",
"properties": {}
},
"variables": {}
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
profile: {
email: 'jsmith@example.com',
externalId: '<string>',
userId: '<string>',
anonymousId: '<string>',
properties: {}
},
variables: {}
})
};
fetch('http://localhost:3001/api/v1/journeys/{journeyKey}/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/journeys/{journeyKey}/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'profile' => [
'email' => 'jsmith@example.com',
'externalId' => '<string>',
'userId' => '<string>',
'anonymousId' => '<string>',
'properties' => [
]
],
'variables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/journeys/{journeyKey}/trigger"
payload := strings.NewReader("{\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"userId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"properties\": {}\n },\n \"variables\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/api/v1/journeys/{journeyKey}/trigger")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"userId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"properties\": {}\n },\n \"variables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/journeys/{journeyKey}/trigger")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"userId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"properties\": {}\n },\n \"variables\": {}\n}"
response = http.request(request)
puts response.read_body{
"runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Authorizations
Unified API key for server-side SDK and API integrations
Headers
Required idempotency key. Reusing it with the same resolved journey/profile/variables replays the original trigger response.
Required string length:
1 - 255Path Parameters
Stable developer key for the Journey.
Required string length:
1 - 120Body
application/json
Response
Default Response
⌘I

