Journeys

Message variable catalog

List the variables a SEND_MESSAGE template binding can reference for a journey — the same set the builder offers, and the authority on what resolves for THIS journey (when docs and this catalog disagree, trust the catalog). customer.* and person.* are offered for every trigger type (person.* is read live at send time from the identity the enrollment named — personExternalId, which event triggers always carry — and only falls back to a phone/email lookup, blank on zero or several matches, for contacts enrolled without a CDP person). The trigger-aware part is participant data: event-triggered journeys get the event payload under engagement.workflowState.* and no engagement.context., segment-triggered journeys get segment output columns under engagement.workflowState., and manual/CSV enrollment populates engagement.context.*. Bind a template placeholder to one of the returned path values (custom person attributes are person.<key>, NOT attributes.<key> — that is the DECISION/CASE condition syntax). A binding may append ONE formatting helper after a pipe: currency:MXN (code required), date or date:long, sum / sum:field, count, fixed:N — e.g. “engagement.nodeOutputs.fetch.body.total | currency:MXN”. No chaining. currency/date are localized to the org language; sum/count/fixed are deliberately NOT, so they stay parseable by a DECISION comparison and valid inside a JSON body. Applied to a missing value the helper is skipped entirely, so a gap renders blank rather than “NaN” or “Invalid Date”. count is the one to reach for before indexing an array: binding body.buyers.0.account on a plural array picks an arbitrary element, so gate a DECISION on count eq 1 instead of guessing. Pass a journey id or its initiative id.

GET

api

journeys

{journeyId}

message-variables

Message variable catalog

curl --request GET \
  --url https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "groups": [
    {
      "id": "<string>",
      "label": "<string>",
      "variables": [
        {
          "key": "<string>",
          "label": "<string>",
          "path": "<string>",
          "description": "<string>"
        }
      ],
      "description": "<string>"
    }
  ],
  "notes": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

journeyId

string

required

A journey id, or the initiative id (resolves to its current draft).

Minimum string length: 1

Response

Success

groups

object[]

required

Show child attributes

notes

string

Trigger-specific caveats. Present for event-triggered journeys: explains why the person.* and engagement.context.* groups are absent.

Message variable catalog

curl --request GET \
  --url https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.useboom.ai/api/v1/journeys/{journeyId}/message-variables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "groups": [
    {
      "id": "<string>",
      "label": "<string>",
      "variables": [
        {
          "key": "<string>",
          "label": "<string>",
          "path": "<string>",
          "description": "<string>"
        }
      ],
      "description": "<string>"
    }
  ],
  "notes": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Overview

Initiatives

Journeys

Segments

WhatsApp

Email templates

Message logs

Message variable catalog

Authorizations

Path Parameters

Response