What is the Integration Builder?
The Integration Builder is the configuration area for a single custom integration between Journeys and a third-party system.
All users with access to your Journeys company account can create and edit integrations and use their actions in journeys.
Accessing the Integration Builder
To find the Integration Builder:
Click Settings in the left navigation bar
Select Integrations
This opens a list of all custom integrations created for the company account.
From the integrations list, you can search, sort, and create new integrations.
Each integration in the list displays the:
Integration name
Optional description and logo
Connection status (Connected or Not Connected)
Number of journeys using the integration
Number of endpoints and webhooks
To open the Integration Builder for a specific integration, all you need to do is click it in the list.
Creating a new integration
To create a new integration:
From the integrations list, click Add new integration in the top-right corner
Provide:
Name (required)
Description (optional)
Integration logo (optional, .png or .jpg)
Click Add custom integration
The integration is created and its Integration Builder opens automatically.
Integration Builder layout
The Integration Builder consists of three tabs:
Details tab
This is where the integration is configured.
From the Details tab, you can:
Set up authentication
Create endpoints
Create webhooks
Test endpoints and see test responses
Adjust request and response values
Journeys tab
Shows all journeys that use this integration.
Clicking a journey opens the Travellers tab for that journey.
Settings tab
Contains settings to change how the integration behaves.
Currently, the Settings tab only contains Empty field handling, which defines how empty fields are sent in requests:
Send empty strings as empty ("") *Default
Send empty strings as null
Skip empty fields in requests
Authentication
Each integration can have one authentication method.
Authentication is configured from the Details tab by clicking Authenticate or Edit, depending on whether authentication has already been set.
Supported authentication types are:
None
Basic
Bearer token
OAuth2
API key
Authorization header
JWT token
Some authentication types must be successfully tested before they can be saved.
Endpoints
What are endpoints?
Journeys sends data to external systems via endpoints.
An endpoint represents a reusable request that typically performs a single action in a third-party system.
Examples include:
Create an employee in BambooHR
Send a message to a Slack channel
Mark an issue as done in Jira
Creating endpoints
Endpoints are created from the Add Endpoint button in the top-right corner of the Integration Builder.
You can add:
API endpoints for outgoing requests
Webhooks for receiving incoming data from the other system
Endpoint testing requirement
Before an endpoint can be used as an action in journeys, it must be successfully tested in the Integration Builder.
An endpoint will not appear in the Journey Builder until a test request has returned a successful response.
This ensures only working endpoints can be used in journeys.
Using integrations in journeys
Once an endpoint has been created and successfully tested:
It appears in the list of available integration actions in all journeys.
It can be added as an action in any journey.
Request values can be dynamically mapped from journey and traveller data
Response values returned by the external system can be used as input in later actions
