API and webhooks
Add people to journeys from your own software, and get told when things happen.
The API, webhooks and workflow rules come with Business. An Admin manages them under Settings > API & webhooks.
API keys
Click New API key, give it a name and copy the key (it starts with mak_). It is shown once. A key acts as the person who made it, with their Marketing Automation role. Each key can make 5,000 calls a day. Turn a key off at any time.
Send it with each call:
Authorization: Bearer mak_...Calls
| Call | What it does |
|---|---|
GET /marketing-automation/api.php/v1/journeys?status=running | Your journeys with their numbers |
POST /marketing-automation/api.php/v1/journeys/{id}/people | Adds people to a running journey |
GET /marketing-automation/api.php/v1/people?email=... | Where a person is: each journey they are or were in |
POST /marketing-automation/api.php/v1/people/{id}/remove | Takes a person out of a journey |
Adding people:
POST .../v1/journeys/12/people
{"people": [{"email": "asha@example.com", "first_name": "Asha", "phone": "+15550100", "fields": {"order_no": "WEB-1042"}}]}The same rules apply as for people added by hand: consent, unsubscribes, coming in again and your plan's contacts. The answer says how many were added and why others were skipped. fields become personal fields in messages, such as {{order_no}}.
Webhooks
Click New webhook, enter your address (https) and choose the events:
| Event | When |
|---|---|
journey.started, journey.paused, journey.stopped | A journey changes state |
person.entered | Someone comes into a journey |
person.goal | Someone reaches a journey's goal |
person.finished | Someone finishes a journey |
lead.hot | Someone becomes a hot lead |
Each call is a POST with a JSON body, signed with your webhook's secret in the X-Ellibo-Signature header (HMAC-SHA256 of the body). Failed calls are tried again for a day. Send a test checks your address.
An action step can also call a webhook for a person at any point in a journey. See Conditions, splits and goals.
Workflow rules
Under Settings > Workflow rules, make rules such as when a journey is paused, email the marketing team. Rules can notify, email or call a webhook.