Create a new workflow
curl --request POST \
--url https://api.subscriber.dev/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"subject": "<string>",
"body": "<string>",
"delayMs": 0,
"layout": "default",
"previewText": "<string>"
}
],
"description": "<string>",
"type": "automation",
"channels": {
"email": {
"fromName": "<string>",
"replyTo": "jsmith@example.com"
}
},
"triggers": [
{
"source": "<string>",
"event": "<string>"
}
],
"exitConditions": [
{
"source": "<string>",
"event": "<string>"
}
]
}
'import requests
url = "https://api.subscriber.dev/workflows"
payload = {
"key": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"subject": "<string>",
"body": "<string>",
"delayMs": 0,
"layout": "default",
"previewText": "<string>"
}
],
"description": "<string>",
"type": "automation",
"channels": { "email": {
"fromName": "<string>",
"replyTo": "jsmith@example.com"
} },
"triggers": [
{
"source": "<string>",
"event": "<string>"
}
],
"exitConditions": [
{
"source": "<string>",
"event": "<string>"
}
]
}
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({
key: '<string>',
name: '<string>',
steps: [
{
type: 'email',
subject: '<string>',
body: JSON.stringify('<string>'),
delayMs: 0,
layout: 'default',
previewText: '<string>'
}
],
description: '<string>',
type: 'automation',
channels: {email: {fromName: '<string>', replyTo: 'jsmith@example.com'}},
triggers: [{source: '<string>', event: '<string>'}],
exitConditions: [{source: '<string>', event: '<string>'}]
})
};
fetch('https://api.subscriber.dev/workflows', 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.subscriber.dev/workflows",
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([
'key' => '<string>',
'name' => '<string>',
'steps' => [
[
'type' => 'email',
'subject' => '<string>',
'body' => '<string>',
'delayMs' => 0,
'layout' => 'default',
'previewText' => '<string>'
]
],
'description' => '<string>',
'type' => 'automation',
'channels' => [
'email' => [
'fromName' => '<string>',
'replyTo' => 'jsmith@example.com'
]
],
'triggers' => [
[
'source' => '<string>',
'event' => '<string>'
]
],
'exitConditions' => [
[
'source' => '<string>',
'event' => '<string>'
]
]
]),
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.subscriber.dev/workflows"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"delayMs\": 0,\n \"layout\": \"default\",\n \"previewText\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"automation\",\n \"channels\": {\n \"email\": {\n \"fromName\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\"\n }\n },\n \"triggers\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ],\n \"exitConditions\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\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.subscriber.dev/workflows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"delayMs\": 0,\n \"layout\": \"default\",\n \"previewText\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"automation\",\n \"channels\": {\n \"email\": {\n \"fromName\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\"\n }\n },\n \"triggers\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ],\n \"exitConditions\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.subscriber.dev/workflows")
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 \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"delayMs\": 0,\n \"layout\": \"default\",\n \"previewText\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"automation\",\n \"channels\": {\n \"email\": {\n \"fromName\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\"\n }\n },\n \"triggers\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ],\n \"exitConditions\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"publicId": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"status": "active",
"type": "automation",
"channels": {
"email": {
"fromName": "<string>",
"replyTo": "<string>"
}
},
"steps": [
{
"publicId": "<string>",
"stepOrder": 123,
"type": "<string>",
"delayMs": 123,
"subject": "<string>",
"body": "<string>",
"layout": "default",
"previewText": "<string>",
"url": "<string>"
}
],
"triggers": [
{
"source": "<string>",
"event": "<string>",
"label": "<string>",
"active": true
}
],
"exitConditions": [
{
"source": "<string>",
"event": "<string>",
"label": "<string>",
"active": true
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"editUrl": "<string>"
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}Workflows
Create a new workflow
Creates a workflow definition: a named, ordered sequence of steps (email or webhook), each with a delay relative to the previous step. Optional triggers start it automatically on events from connected integrations, e.g. Stripe’s trial_started, and exitConditions stop a person’s active run on others.
POST
/
workflows
Create a new workflow
curl --request POST \
--url https://api.subscriber.dev/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"subject": "<string>",
"body": "<string>",
"delayMs": 0,
"layout": "default",
"previewText": "<string>"
}
],
"description": "<string>",
"type": "automation",
"channels": {
"email": {
"fromName": "<string>",
"replyTo": "jsmith@example.com"
}
},
"triggers": [
{
"source": "<string>",
"event": "<string>"
}
],
"exitConditions": [
{
"source": "<string>",
"event": "<string>"
}
]
}
'import requests
url = "https://api.subscriber.dev/workflows"
payload = {
"key": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"subject": "<string>",
"body": "<string>",
"delayMs": 0,
"layout": "default",
"previewText": "<string>"
}
],
"description": "<string>",
"type": "automation",
"channels": { "email": {
"fromName": "<string>",
"replyTo": "jsmith@example.com"
} },
"triggers": [
{
"source": "<string>",
"event": "<string>"
}
],
"exitConditions": [
{
"source": "<string>",
"event": "<string>"
}
]
}
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({
key: '<string>',
name: '<string>',
steps: [
{
type: 'email',
subject: '<string>',
body: JSON.stringify('<string>'),
delayMs: 0,
layout: 'default',
previewText: '<string>'
}
],
description: '<string>',
type: 'automation',
channels: {email: {fromName: '<string>', replyTo: 'jsmith@example.com'}},
triggers: [{source: '<string>', event: '<string>'}],
exitConditions: [{source: '<string>', event: '<string>'}]
})
};
fetch('https://api.subscriber.dev/workflows', 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.subscriber.dev/workflows",
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([
'key' => '<string>',
'name' => '<string>',
'steps' => [
[
'type' => 'email',
'subject' => '<string>',
'body' => '<string>',
'delayMs' => 0,
'layout' => 'default',
'previewText' => '<string>'
]
],
'description' => '<string>',
'type' => 'automation',
'channels' => [
'email' => [
'fromName' => '<string>',
'replyTo' => 'jsmith@example.com'
]
],
'triggers' => [
[
'source' => '<string>',
'event' => '<string>'
]
],
'exitConditions' => [
[
'source' => '<string>',
'event' => '<string>'
]
]
]),
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.subscriber.dev/workflows"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"delayMs\": 0,\n \"layout\": \"default\",\n \"previewText\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"automation\",\n \"channels\": {\n \"email\": {\n \"fromName\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\"\n }\n },\n \"triggers\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ],\n \"exitConditions\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\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.subscriber.dev/workflows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"delayMs\": 0,\n \"layout\": \"default\",\n \"previewText\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"automation\",\n \"channels\": {\n \"email\": {\n \"fromName\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\"\n }\n },\n \"triggers\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ],\n \"exitConditions\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.subscriber.dev/workflows")
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 \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"delayMs\": 0,\n \"layout\": \"default\",\n \"previewText\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"automation\",\n \"channels\": {\n \"email\": {\n \"fromName\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\"\n }\n },\n \"triggers\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ],\n \"exitConditions\": [\n {\n \"source\": \"<string>\",\n \"event\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"publicId": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"status": "active",
"type": "automation",
"channels": {
"email": {
"fromName": "<string>",
"replyTo": "<string>"
}
},
"steps": [
{
"publicId": "<string>",
"stepOrder": 123,
"type": "<string>",
"delayMs": 123,
"subject": "<string>",
"body": "<string>",
"layout": "default",
"previewText": "<string>",
"url": "<string>"
}
],
"triggers": [
{
"source": "<string>",
"event": "<string>",
"label": "<string>",
"active": true
}
],
"exitConditions": [
{
"source": "<string>",
"event": "<string>",
"label": "<string>",
"active": true
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"editUrl": "<string>"
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}Authorizations
bearerapi-key
A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.
Body
application/json
Stable identifier used to trigger this workflow, e.g. "user-signup". Unique within the environment.
Required string length:
1 - 255Required string length:
1 - 255Required array length:
1 - 50 elements- Option 1
- Option 2
Show child attributes
Show child attributes
Maximum string length:
2000Purely organizational: automation workflows are meant to be triggered individually per-subscriber; broadcast workflows are meant to be fanned out via the broadcast endpoint. Either can technically still be used either way.
Available options:
automation, broadcast Settings for each channel this workflow sends on. Channel-specific, so the workflow itself stays channel-neutral.
Show child attributes
Show child attributes
Events from connected integrations that start this workflow for the person they're about. Automation workflows only; the integration must be connected first.
Maximum array length:
50Show child attributes
Show child attributes
Events from connected integrations that stop this workflow for the person they're about: their active runs are cancelled and unsent steps never send. Checked before triggers, so an event in both restarts the workflow. Automation workflows only; the integration must be connected first.
Maximum array length:
50Show child attributes
Show child attributes
Response
Available options:
active, paused Available options:
automation, broadcast Settings for each channel this workflow sends on.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Link to edit this workflow's emails in the web editor. Share it when someone wants to tweak the copy or preview an email.