Boom Ai

Boom Ai Journeys API

The Journeys API from Boom Ai — 16 operation(s) for journeys.

GitHub OpenAPI

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/journeys List my journeys · List journeys #
Ask an LLM
“Which journeys has my organization built, and which ones are live?”
“Can I see only the journeys attached to one initiative?”
Tell an agent
List my journeys, newest first.
Show the journeys for initiative {initiativeId} with status {status}.
POST /api/v1/journeys Create a draft journey from a full graph · Create draft #
Ask an LLM
“How do I create a brand-new journey for an initiative from a complete node graph?”
“Do I have to give node positions when creating a journey, or are they laid out for me?”
Tell an agent
Create a new draft journey on initiative {initiativeId} with graph {definition}.
Build a fresh journey for initiative {initiativeId} from this definition: {definition}.
GET /api/v1/journeys/{journeyId} Get a journey's trigger and steps · Get journey #
Ask an LLM
“What triggers a journey and what steps do people move through in it?”
“Can I get a quick read-only summary of one journey's setup?”
Tell an agent
Show me journey {journeyId}.
Summarize the trigger and ordered steps of journey {journeyId}.
PATCH /api/v1/journeys/{journeyId} Replace a draft journey's whole graph · Update draft #
Ask an LLM
“How do I overwrite an existing draft journey's entire graph in one call?”
“Does saving a new graph over a draft wipe its environment pin?”
Tell an agent
Replace the graph of draft journey {journeyId} with {definition}.
Save this full definition back onto draft journey {journeyId}: {definition}.
GET /api/v1/journeys/{journeyId}/definition Get a journey's full editable graph · Get journey definition #
Ask an LLM
“Where do I get every node's config and connection so I can edit a journey and save it back?”
“What is the difference between a journey's public summary and its full authoring definition?”
Tell an agent
Fetch the full editable definition of journey {journeyId}.
Give me all nodes, config and edges of journey {journeyId}.
DELETE /api/v1/journeys/{journeyId}/edges Remove edges leaving a journey node · Disconnect nodes #
Ask an LLM
“How do I remove the connection between two steps in a journey?”
“What happens if I disconnect a node without naming a target or handle?”
Tell an agent destructive · confirm first
Remove all outgoing edges from node {from} in journey {journeyId}.
Disconnect node {from} from node {to} in journey {journeyId}.
POST /api/v1/journeys/{journeyId}/edges Connect two journey nodes · Connect nodes #
Ask an LLM
“How do I route a journey to the next step when someone replies?”
“Can one output handle on a node lead to more than one node?”
Tell an agent
In journey {journeyId}, connect node {from} to node {to} on the {sourceHandle} signal.
Wire the {sourceHandle} output of {from} to {to} in journey {journeyId}.
POST /api/v1/journeys/{journeyId}/fork Fork a live journey into an editable draft · Fork journey #
Ask an LLM
“How can I safely edit a journey that is already live?”
“Does copying a published journey into a draft stop the live one?”
Tell an agent
Fork published journey {journeyId} into a new draft.
Make an editable copy of live journey {journeyId}.
GET /api/v1/journeys/{journeyId}/message-variables List variables a message template can use · Message variable catalog #
Ask an LLM
“Which customer and person variables can I bind into a SEND_MESSAGE template for this journey?”
“What personalization fields actually resolve in a journey's WhatsApp messages?”
Tell an agent
List the message variables available in journey {journeyId}.
Show which template bindings resolve for journey {journeyId}.
POST /api/v1/journeys/{journeyId}/nodes Add a node to a draft journey · Add node #
Ask an LLM
“How do I add a single new step to a draft journey without resending the whole graph?”
“Does a newly added journey node get connected automatically?”
Tell an agent
Add node {node} to draft journey {journeyId}.
Insert this step into journey {journeyId}: {node}.
DELETE /api/v1/journeys/{journeyId}/nodes/{nodeId} Delete a node from a draft journey · Delete node #
Ask an LLM
“How do I remove a step from a draft journey?”
“Are the edges attached to a node removed when I delete it?”
Tell an agent destructive · confirm first
Delete node {nodeId} from journey {journeyId}.
Remove step {nodeId} and its connections from draft journey {journeyId}.
PATCH /api/v1/journeys/{journeyId}/nodes/{nodeId} Update one journey node's config · Update node #
Ask an LLM
“Can I rename or reconfigure a single step in a draft journey?”
“Are node inputs replaced or merged when I update a step?”
Tell an agent
Rename node {nodeId} in journey {journeyId} to {name}.
Merge {inputs} into the config of node {nodeId} in journey {journeyId}.
POST /api/v1/journeys/{journeyId}/publish Publish a draft journey and start outreach · Publish journey #
Ask an LLM
“How do I make a draft journey go live and start enrolling people?”
“When I publish a segment-triggered journey, can it also enroll people already in the segment?”
Tell an agent
Publish journey {journeyId}, confirming it will start real outreach.
Go live with journey {journeyId} and backfill existing segment members.
POST /api/v1/journeys/{journeyId}/stop Stop and retire a live journey · Stop journey #
Ask an LLM
“How do I halt a live journey so nobody else gets enrolled?”
“What happens to people already enrolled but not yet messaged when a journey is stopped?”
Tell an agent destructive · confirm first
Stop live journey {journeyId}, confirming the outreach halt.
Retire journey {journeyId} permanently.
PATCH /api/v1/journeys/{journeyId}/trigger Set how people enter a journey · Set trigger #
Ask an LLM
“Can a journey start automatically when someone joins a segment or fires an event?”
“Is there a frequency cap on how often one person can enter a journey?”
Tell an agent
Trigger journey {journeyId} when people join segment {segmentId}.
Set journey {journeyId} to start on the {eventName} event.
GET /api/v1/journeys/catalog Describe every journey node kind · Node catalog #
Ask an LLM
“What kinds of steps can a journey contain, and what signals does each one emit?”
“What are the rules for connecting journey nodes?”
Tell an agent
Show me the journey node catalog.
List every journey node kind with its inputs and output handles.
GET /api/v1/journeys/condition-catalog List attributes usable in journey conditions · Condition catalog #
Ask an LLM
“Which person attributes and computed values can a journey decision branch on?”
“What operators are allowed in a DECISION condition for each attribute type?”
Tell an agent
Show the attributes and operators I can use in journey decision conditions.
List the condition catalog for building CASE branches.
GET /api/v1/journeys/email-templates List email templates #
GET /api/v1/journeys/event-catalog List CDP event names seen for my org · Event catalog #
Ask an LLM
“Which event names can I use to trigger a journey?”
“What behavioral events has Boom seen for my organization so far?”
Tell an agent
List the event names available for journey triggers.
Show the event catalog for event-based decisions and dispatch nodes.
GET /api/v1/journeys/message-channels List WhatsApp channels a journey can send from · List message channels #
Ask an LLM
“Which WhatsApp channels can a send-message step use?”
“Where do I find the channel id to pin on a SEND_MESSAGE node?”
Tell an agent
List the WhatsApp channels journeys can send from.
Show me the message channel ids for journey send steps.
GET /api/v1/journeys/message-templates List approved templates for a journey channel · List message templates #
Ask an LLM
“Which approved WhatsApp templates can a send-message step use on a given channel?”
“Why doesn't a template show up for my journey's send step on another channel?”
Tell an agent
List the approved templates a journey can send on channel {channelId}.
Show SEND_MESSAGE template options for channel {channelId}.
POST /api/v1/journeys/validate Validate a journey before publishing · Validate journey #
Ask an LLM
“Will my draft journey pass the publish checks, and what issues would block it?”
“Can I check a journey graph for errors without saving it?”
Tell an agent
Validate draft journey {journeyId}.
Dry-run the publish checks on this graph: {definition}.

Documentation

📖
Documentation
https://docs.useboom.ai
📖
APIReference
https://docs.useboom.ai/api-reference/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/boom-ai/refs/heads/main/openapi/boom-ai-journeys-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/boom-ai:boom-ai-journeys-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

boom-ai-journeys-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Boom Journeys API
  version: 1.0.0
  description: 'Boom''s public REST API — one uniform surface over every platform capability. CDP: upsert people and custom objects, define object and relationship types, link and unlink relationships, and record behavioral events — one record per request or up to 1000 per request via the `/batch` endpoints. Segments: read (list, read, membership) and full authoring — discover the filterable catalog, validate a filter, create and update segments, preview match counts, and trigger evaluation. Initiatives: create and configure outreach initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel, archive), and read collected-data summaries. Participants: enroll people into an active initiative, track their status, read conversation transcripts, and stop outreach. Journeys: read-only access to always-on message flows and their metrics. WhatsApp templates: list your WhatsApp numbers and list, read, and create message templates. The same capabilities are exposed as MCP tools with identical schemas.'
servers:
- url: https://www.useboom.ai
  description: Production
- url: https://dev.useboom.ai
  description: Development (sandbox — use a development organization API key)
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (1932 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/boom-ai/refs/heads/main/openapi/boom-ai-journeys-api-openapi.yml