Create an automation workflow (label, description, trigger, partner types, schedule)
curl --request POST \
--url https://api.journeybee.io/v1/automations/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"description": "<string>",
"trigger_fields": [
"<string>"
],
"trigger_config": {
"kind": "stage_change",
"stageUuid": "<string>"
},
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"schedule": {
"cron_expression": "<string>",
"interval_minutes": 262800,
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "UTC"
}
}
'import requests
url = "https://api.journeybee.io/v1/automations/"
payload = {
"label": "<string>",
"description": "<string>",
"trigger_fields": ["<string>"],
"trigger_config": {
"kind": "stage_change",
"stageUuid": "<string>"
},
"partner_type_referral": True,
"partner_type_reseller": True,
"partner_type_distributor": True,
"schedule": {
"cron_expression": "<string>",
"interval_minutes": 262800,
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "UTC"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
description: '<string>',
trigger_fields: ['<string>'],
trigger_config: {kind: 'stage_change', stageUuid: '<string>'},
partner_type_referral: true,
partner_type_reseller: true,
partner_type_distributor: true,
schedule: {
cron_expression: '<string>',
interval_minutes: 262800,
scheduled_at: '2023-11-07T05:31:56Z',
timezone: 'UTC'
}
})
};
fetch('https://api.journeybee.io/v1/automations/', 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://api.journeybee.io/v1/automations/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'description' => '<string>',
'trigger_fields' => [
'<string>'
],
'trigger_config' => [
'kind' => 'stage_change',
'stageUuid' => '<string>'
],
'partner_type_referral' => true,
'partner_type_reseller' => true,
'partner_type_distributor' => true,
'schedule' => [
'cron_expression' => '<string>',
'interval_minutes' => 262800,
'scheduled_at' => '2023-11-07T05:31:56Z',
'timezone' => 'UTC'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.journeybee.io/v1/automations/"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_fields\": [\n \"<string>\"\n ],\n \"trigger_config\": {\n \"kind\": \"stage_change\",\n \"stageUuid\": \"<string>\"\n },\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"schedule\": {\n \"cron_expression\": \"<string>\",\n \"interval_minutes\": 262800,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"UTC\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.journeybee.io/v1/automations/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_fields\": [\n \"<string>\"\n ],\n \"trigger_config\": {\n \"kind\": \"stage_change\",\n \"stageUuid\": \"<string>\"\n },\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"schedule\": {\n \"cron_expression\": \"<string>\",\n \"interval_minutes\": 262800,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"UTC\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/automations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_fields\": [\n \"<string>\"\n ],\n \"trigger_config\": {\n \"kind\": \"stage_change\",\n \"stageUuid\": \"<string>\"\n },\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"schedule\": {\n \"cron_expression\": \"<string>\",\n \"interval_minutes\": 262800,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"UTC\"\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"description": "<string>",
"active": true,
"trigger_type": "entity_change",
"trigger_entity": "partnership",
"trigger_event": "created",
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"created_at": "<string>",
"updated_at": "<string>",
"trigger_fields": [
"<string>"
],
"trigger_config": {
"kind": "stage_change",
"triggerOn": "enter",
"stageUuid": "<string>",
"phase": "backlog",
"stageType": "partnership_stage"
},
"schedule": {
"schedule_type": "cron",
"cron_expression": "<string>",
"interval_minutes": 123,
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>"
},
"workflow_definition": {
"nodes": [
{
"id": "<string>",
"type": "trigger",
"position": {
"x": 123,
"y": 123
},
"data": {
"label": "<string>",
"triggerType": "entity_change"
}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>"
}
]
}
}Automations
Create an automation workflow (label, description, trigger, partner types, schedule)
Creates an inactive draft. The trigger, partner types and schedule are optional: an omitted trigger starts as an unset entity_change trigger, and omitted partner types start as every partner type the company runs. Add the graph with updateAutomationWorkflow and switch the workflow on with toggleAutomation.
POST
/
automations
/
Create an automation workflow (label, description, trigger, partner types, schedule)
curl --request POST \
--url https://api.journeybee.io/v1/automations/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"description": "<string>",
"trigger_fields": [
"<string>"
],
"trigger_config": {
"kind": "stage_change",
"stageUuid": "<string>"
},
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"schedule": {
"cron_expression": "<string>",
"interval_minutes": 262800,
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "UTC"
}
}
'import requests
url = "https://api.journeybee.io/v1/automations/"
payload = {
"label": "<string>",
"description": "<string>",
"trigger_fields": ["<string>"],
"trigger_config": {
"kind": "stage_change",
"stageUuid": "<string>"
},
"partner_type_referral": True,
"partner_type_reseller": True,
"partner_type_distributor": True,
"schedule": {
"cron_expression": "<string>",
"interval_minutes": 262800,
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "UTC"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
description: '<string>',
trigger_fields: ['<string>'],
trigger_config: {kind: 'stage_change', stageUuid: '<string>'},
partner_type_referral: true,
partner_type_reseller: true,
partner_type_distributor: true,
schedule: {
cron_expression: '<string>',
interval_minutes: 262800,
scheduled_at: '2023-11-07T05:31:56Z',
timezone: 'UTC'
}
})
};
fetch('https://api.journeybee.io/v1/automations/', 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://api.journeybee.io/v1/automations/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'description' => '<string>',
'trigger_fields' => [
'<string>'
],
'trigger_config' => [
'kind' => 'stage_change',
'stageUuid' => '<string>'
],
'partner_type_referral' => true,
'partner_type_reseller' => true,
'partner_type_distributor' => true,
'schedule' => [
'cron_expression' => '<string>',
'interval_minutes' => 262800,
'scheduled_at' => '2023-11-07T05:31:56Z',
'timezone' => 'UTC'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.journeybee.io/v1/automations/"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_fields\": [\n \"<string>\"\n ],\n \"trigger_config\": {\n \"kind\": \"stage_change\",\n \"stageUuid\": \"<string>\"\n },\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"schedule\": {\n \"cron_expression\": \"<string>\",\n \"interval_minutes\": 262800,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"UTC\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.journeybee.io/v1/automations/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_fields\": [\n \"<string>\"\n ],\n \"trigger_config\": {\n \"kind\": \"stage_change\",\n \"stageUuid\": \"<string>\"\n },\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"schedule\": {\n \"cron_expression\": \"<string>\",\n \"interval_minutes\": 262800,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"UTC\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/automations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_fields\": [\n \"<string>\"\n ],\n \"trigger_config\": {\n \"kind\": \"stage_change\",\n \"stageUuid\": \"<string>\"\n },\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"schedule\": {\n \"cron_expression\": \"<string>\",\n \"interval_minutes\": 262800,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"UTC\"\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"description": "<string>",
"active": true,
"trigger_type": "entity_change",
"trigger_entity": "partnership",
"trigger_event": "created",
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"created_at": "<string>",
"updated_at": "<string>",
"trigger_fields": [
"<string>"
],
"trigger_config": {
"kind": "stage_change",
"triggerOn": "enter",
"stageUuid": "<string>",
"phase": "backlog",
"stageType": "partnership_stage"
},
"schedule": {
"schedule_type": "cron",
"cron_expression": "<string>",
"interval_minutes": 123,
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>"
},
"workflow_definition": {
"nodes": [
{
"id": "<string>",
"type": "trigger",
"position": {
"x": 123,
"y": 123
},
"data": {
"label": "<string>",
"triggerType": "entity_change"
}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>"
}
]
}
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
application/json
Available options:
entity_change, user_action, scheduled, manual, stage_change, engagement Available options:
partnership, lead, deal, resource, certification, user, card, campaign, form, engagement, task, room, agreement Entity-change triggers only; null for every other trigger type.
Available options:
created, updated, deleted, viewed, completed, stage_entered, stage_exited, started, downloaded, clicked, shared, submitted, failed, goal_completed, form_submitted, goal_date_reached, sent, signed, declined, voided, expired Entity-change updated triggers: the columns to watch. Null = any field.
Maximum array length:
100Maximum string length:
200The trigger's detail, keyed by kind, which must match the trigger: certification, task and the room kinds (room_goal for goal_completed, room_form for form_submitted, room_goal_date for goal_date_reached) follow trigger_entity; otherwise stage_change, scheduled or entity_change follow trigger_type.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
Scheduled triggers only: when the workflow runs. Null = no cadence (what a GET returns for any other trigger).
Show child attributes
Show child attributes
Response
201 - application/json
Default Response
Available options:
entity_change, user_action, scheduled, manual, stage_change, engagement Available options:
partnership, lead, deal, resource, certification, user, card, campaign, form, engagement, task, room, agreement Available options:
created, updated, deleted, viewed, completed, stage_entered, stage_exited, started, downloaded, clicked, shared, submitted, failed, goal_completed, form_submitted, goal_date_reached, sent, signed, declined, voided, expired Null only when the stored trigger refers to a room, block or stage that no longer exists (it can never fire as saved); send a new trigger_config to repair it.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
The cadence of a scheduled trigger; null for any other trigger.
Show child attributes
Show child attributes
Show child attributes
Show child attributes