How to Create a Gate

Prerequisites #

Before creating a Gate, ensure you have:

• At least one Agent configured (see Build an Agent in 5 Minutes)
• Understanding of What is a Gate?

Overview #

This guide shows how to create a Gate to receive external data, map it to Candidates, and automatically start a Journey.

How It Works #

1. External system sends data
2. Gate receives the request
3. Data is mapped to Candidate fields
4. Routing rules determine the Agent
5. Candidate is created and enters the Journey

How to Configure #

1. Open the Gates section from the left-hand menu.

2. Click Add Gate (or equivalent).
3. Fill in basic details:

• Gate name
• Description (optional)

4. Copy credentials:
   • Gate URL
   • API Key
5. Configure Field Mapping:

• Map incoming data fields to Candidate record fields

6. (Optional) Configure Routing Rules:

• Define conditions to route Candidates to different Agents

7. Test the Gate using Test mode before switching to Live.

8. Click Save.

The Gate is now ready to receive data.

What Happens After Setup #

When data is sent to the Gate:

• A Candidate is created automatically
• Data is stored in mapped fields
• Candidate is assigned to an Agent
• The Journey starts from the first Step

Tips #

• Start with minimal fields (email, name, phone)
• Always test before switching to Live
• Use routing rules only when needed
• Keep parameter names consistent with your source

Example #

Sample payload:
{
"email": "test@example.com",
"name": "John",
"campaign": "facebook"
}

Result:

• Candidate is created
• Campaign is stored as source
• Candidate is routed to the correct Agent

Notes #

• Gate must be set to Open to accept real data
• Unmapped fields will be ignored
• API Key is required for authentication
• Use Test mode before Live to avoid errors

Related Pages #

• What is a Gate?
• Build an Agent in 5 Minutes
• Path and Gate Troubleshooting