Journeys

Condition catalog

List the person attributes and computed attributes available for DECISION and CASE CONDITIONS, plus the custom object types. Attribute tokens are ready to use as condition selection paths (e.g. attributes.plan, computed.ltv). NOTE: these attributes.* tokens are ONLY for DECISION/CASE conditions — SEND_MESSAGE template bindings use a different syntax (person.<key>); call journeys_message_variables for those. Also describes the cdp_predicate DECISION condition term shape: which op values are legal per attribute type (operatorsByType), and which value shape each op expects (cdpPredicateValueShapes).

GET

api

journeys

condition-catalog

Condition catalog

curl --request GET \
  --url https://www.useboom.ai/api/v1/journeys/condition-catalog \
  --header 'Authorization: Bearer <token>'

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

fetch('https://www.useboom.ai/api/v1/journeys/condition-catalog', 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/condition-catalog",
  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/condition-catalog"

	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/condition-catalog")

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

{
  "person": [
    {
      "attr": "<string>",
      "label": "<string>",
      "type": "<string>"
    }
  ],
  "computed": [
    {
      "attr": "<string>",
      "label": "<string>",
      "type": "<string>"
    }
  ],
  "objectTypes": [
    {
      "name": "<string>",
      "displayName": "<string>"
    }
  ],
  "conversation": [
    {
      "path": "<string>",
      "type": "<string>",
      "description": "<string>"
    }
  ],
  "operatorsByType": {},
  "cdpPredicateValueShapes": "<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_....

Response

Success

person

object[]

required

Show child attributes

computed

object[]

required

Show child attributes

objectTypes

object[]

required

Show child attributes

conversation

object[]

required

Conversation-recency paths for a DECISION value condition. A CLOSED set — any other key under engagement.conversation. is refused at publish, because a blank resolve there would read as 0 and open a gate that should be shut. Not available to CASE. This list is the DECISION view only: the same root also carries id and inboxUrl, which resolve in an HTTP_REQUEST node and are refused in a condition (nothing compares usefully against an id, and a numeric op would coerce it to 0 and take the branch).

Show child attributes

operatorsByType

object

required

Legal op values for a cdp_predicate condition term, keyed by its type.

Show child attributes

cdpPredicateValueShapes

string

required

Explains a cdp_predicate term's fields and the value shape each op expects.

Condition catalog

curl --request GET \
  --url https://www.useboom.ai/api/v1/journeys/condition-catalog \
  --header 'Authorization: Bearer <token>'

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

fetch('https://www.useboom.ai/api/v1/journeys/condition-catalog', 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/condition-catalog",
  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/condition-catalog"

	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/condition-catalog")

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

{
  "person": [
    {
      "attr": "<string>",
      "label": "<string>",
      "type": "<string>"
    }
  ],
  "computed": [
    {
      "attr": "<string>",
      "label": "<string>",
      "type": "<string>"
    }
  ],
  "objectTypes": [
    {
      "name": "<string>",
      "displayName": "<string>"
    }
  ],
  "conversation": [
    {
      "path": "<string>",
      "type": "<string>",
      "description": "<string>"
    }
  ],
  "operatorsByType": {},
  "cdpPredicateValueShapes": "<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

Condition catalog

Authorizations

Response