Automations

Automation scenarios: a graph of triggers, conditions, waits and actions; validation, versions, activation, test and trace, run history, statistics, and the contact events API that feeds event triggers (custom events, carts, page visits).

Technická referencia je v angličtine (rovnako ako strojovo čitateľný dokument OpenAPI). Celú skupinu pre AI agenta načítate z /api/openapi.json?tag=Automations.

Prihlásenie: Authorization: Bearer pst_... alebo HTTP Basic (e-mail člena firmy a API kľúč).

Operácie#

List automations#

GET /api/v1/tenants/{tenant}/automations

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_automations

Automations (draft, active, paused) with entered, active and sent counts.

Parametre

Odpovede

• 200 OK: application/json object

Chyby

Create an automation (draft)#

POST /api/v1/tenants/{tenant}/automations

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: create_automation

Creates an automation as a draft (it sends nothing until activate_automation). graph = {nodes, edges} (get_api_reference Automatizace).

Parametre

Telo požiadavky (application/json)

Odpovede

• 201 Created: application/json AutomationDetail

Chyby

Resolve a time spec to a moment (preview)#

POST /api/v1/tenants/{tenant}/automations/resolve-time

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: resolve_automation_time

Previews a time spec of a wait or a condition (calendar, interval or event variant): the moment it means now, in UTC and in the account's local time.

The preview of the shared time choice (core/timespec.py): {spec, place?, base?} -> {at (UTC), local (YYYY-MM-DDTHH:MM of the tenant)}. 400 validation spec with params.issues for an invalid spec.

Parametre

Telo požiadavky (application/json): Required by the server: spec.

Odpovede

• 200 OK: application/json object

Chyby

Change labels of automations#

POST /api/v1/tenants/{tenant}/automations/tags

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full

Parametre

Telo požiadavky (application/json): Required by the server: ids.

Odpovede

• 200 OK: application/json object

Chyby

Validate a graph without saving#

POST /api/v1/tenants/{tenant}/automations/validate

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: validate_automation_graph

Checks a graph without saving: errors and incomplete settings.

{errors, incomplete} of a graph for a shop without saving it (the canvas checks before saving).

Parametre

Telo požiadavky (application/json): Required by the server: graph, shopId.

Odpovede

• 200 OK: application/json AutomationValidation

Chyby

Get an automation with its graph and issues#

GET /api/v1/tenants/{tenant}/automations/{automation_id}

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_automation

One automation with its graph (nodes, edges, version) and the issues that block activation.

Parametre

Odpovede

• 200 OK: application/json AutomationDetail

Chyby

Update name, description or labels of an automation#

PATCH /api/v1/tenants/{tenant}/automations/{automation_id}

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: update_automation

Changes name, description or tags.

Parametre

Telo požiadavky (application/json)

Odpovede

• 200 OK: application/json AutomationDetail

Chyby

Delete an automation that never ran#

DELETE /api/v1/tenants/{tenant}/automations/{automation_id}

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: delete_automation (cez MCP len s náhľadom a potvrdením)

Deletes an automation nobody entered.

Parametre

Odpovede

• 204 No content

Chyby

Activate (start) an automation#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/activate

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: activate_automation (cez MCP len s náhľadom a potvrdením)

Activates (starts) an automation: from now on it sends its e-mails to contacts who enter.

Parametre

Telo požiadavky (application/json)

object

Odpovede

• 200 OK: application/json AutomationDetail

Chyby

Add contacts by hand to a running automation#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/contacts

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: add_automation_contacts (cez MCP len s náhľadom a potvrdením)

Adds contacts by hand to a running automation whose trigger is manual (Ručně přidané kontakty); those that can be mailed enter at the next tick and get its e-mails. The preview shows how many can enter.

Adds contacts by hand ({contactIds}) to a running scenario whose trigger is "Ručně přidané kontakty" (event manual); they enter at the next tick when they may (mailable, customer exception). {added: n}.

Parametre

Telo požiadavky (application/json): Required by the server: contactIds.

Odpovede

• 200 OK: application/json object

Chyby

Copy an automation as a new draft#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/copy

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: copy_automation

Creates a draft copy of an automation ("<name> - kopie", the same graph; webhook passwords are not copied).

A draft copy "<name> - kopie" (SmartEmailing's Vytvořit kopii); webhook passwords are not copied.

Parametre

Telo požiadavky (application/json)

object

Odpovede

• 201 Created: application/json AutomationDetail

Chyby

Live counts per node and output#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/counts

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_automation_counts

Live numbers per node: passed, yes / no, outputs per branch, skipped, failed, left, waiting (contacts waiting there now), holding, queued, sent, opened, clicked; runs per state.

Live numbers per node key: passed, yes, no, skipped, failed, left, outputs per branch, waiting (holding in a storage), queued, sent, opened, clicked; runs per state. Optional from / to (ISO) limit steps and e-mails to a period; waiting is always now.

Parametre

Odpovede

• 200 OK: application/json AutomationCounts

Chyby

Report that the editor has a scenario open and see who else has it#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/editing

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

The editor reports itself every 30 s (AU-16); {"others": [names]} of the other people who have the scenario open. Body {"leave": true} when the editor closes. An API key or an app has no presence (empty list).

Parametre

Telo požiadavky (application/json)

object

Odpovede

• 200 OK: application/json object

Chyby

Everything the editor needs in one answer#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/editor

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Everything the editor opens with in one answer: the detail (as GET .../automations/<id>) and the option catalogs (core/automation_editor.py). A catalog of a module the caller cannot read is empty, as its list endpoint would answer 403.

Parametre

Odpovede

• 200 OK: application/json AutomationEditorData

Chyby

Save the graph of an automation (new version)#

PUT /api/v1/tenants/{tenant}/automations/{automation_id}/graph

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: save_automation_graph (cez MCP len s náhľadom a potvrdením)

Saves the graph of an automation (several triggers allowed). baseVersion = the version you read. A running (active) automation is saved only after the confirm step (its contacts go on by the new graph); a node where contacts wait cannot be removed. Every save keeps a version (list_automation_versions).

Parametre

Telo požiadavky (application/json): Required by the server: baseVersion, graph.

Odpovede

• 200 OK: application/json AutomationDetail

Chyby

Contacts that went through a node#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/nodes/{key}/passes

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_node_passes

Contacts that went through a node, newest first, with the outcome and branch.

Contacts that went through a node (SmartEmailing's "Kontakty, které prošly uzlem"): ?branch, ?q (e-mail), ?from, ?to; newest first.

Parametre

Odpovede

• 200 OK: application/json object

Chyby

Release the contacts waiting in a node#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/nodes/{key}/release

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: release_waiting_contacts (cez MCP len s náhľadom a potvrdením)

Lets every contact waiting in a wait (or a condition waiting for its rules) go on now; they get the next e-mails of the scenario. The preview shows how many wait there.

SmartEmailing's "Uvolnit všechny čekající kontakty" of a wait or a waiting condition: {released: n}.

Parametre

Telo požiadavky (application/json)

object

Odpovede

• 200 OK: application/json object

Chyby

Recompute the end of waiting in a node#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/nodes/{key}/reschedule

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: reschedule_waiting_contacts (cez MCP len s náhľadom a potvrdením)

The contacts waiting in a wait get their end computed again from the node's current settings (after the wait was changed). The preview shows how many wait there.

SmartEmailing's "Aktualizovat dobu čekání": the waiting contacts get the node's current wait: {rescheduled}.

Parametre

Telo požiadavky (application/json)

object

Odpovede

• 200 OK: application/json object

Chyby

Pause an automation#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/pause

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: pause_automation

Pauses an active automation.

Parametre

Telo požiadavky (application/json)

object

Odpovede

• 200 OK: application/json AutomationDetail

Chyby

Statistics of the e-mail nodes (JSON or CSV)#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/report

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_automation_report

Statistics of the scenario for a period: per e-mail node (sent, opens, clicks, conversions), the chosen nodes summed, webhook calls.

Statistics of the scenario: ?from, ?to (local days YYYY-MM-DD, both included), ?nodes=a,b (selected nodes summed), ?format=csv for the table as a file.

Parametre

Odpovede

• 200 JSON, or CSV with format=csv: application/json AutomationReport, text/csv string

Chyby

Run history per contact#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/runs

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_automation_runs

Runs of contacts through the automation with their steps (active = still in it, with the node it waits in and until when).

Run history, newest first, each with its steps; contactId narrows it to one contact of the tenant.

Parametre

Odpovede

• 200 OK: application/json object

Chyby

Test the scenario on today's data (nothing is sent)#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/test

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: test_automation

Dry run of the scenario over today's data: how many contacts would reach, wait in and leave each node. Nothing is saved or sent.

Test of the scenario (AU-05): expected contacts per node of one pass over the current data, nothing written or sent. Body (optional): graph = the editor's graph (default the stored one), days = the replayed window of event triggers (0 to 90, default 0: a Při události trigger lets nobody in, as SmartEmailing's test). A graph with errors or incomplete settings is 400 validation graph with params.issues (as SmartEmailing: "Scénář není možné ... testovat, dokud neopravíte chyby v nastavení").

Parametre

Telo požiadavky (application/json)

Odpovede

• 200 OK: application/json AutomationTest

Chyby

Trace one contact through the scenario (nothing is sent)#

POST /api/v1/tenants/{tenant}/automations/{automation_id}/trace

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: trace_automation

Simulation of one contact: the way it would take through the scenario step by step (conditions, waits, e-mails) with the reasons. Nothing is saved or sent.

The way of one contact through the scenario (core/automation_sim.py trace): body contactId or email, graph (default the stored one), triggerKey (default the first trigger), days (replayed window of an event trigger).

Parametre

Telo požiadavky (application/json)

Odpovede

• 200 OK: application/json AutomationTrace

Chyby

List saved versions of the graph#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/versions

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_automation_versions

Saved versions of the graph, newest first (version, status, saved at and by, node count).

Parametre

Odpovede

• 200 OK: application/json object

Chyby

Get one saved version of the graph#

GET /api/v1/tenants/{tenant}/automations/{automation_id}/versions/{version}

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_automation_version

The graph of one saved version (to compare or to save it again with save_automation_graph).

Parametre

Odpovede

• 200 OK: application/json object

Chyby

Record an event of a contact (custom event, cart, page visit)#

POST /api/v1/tenants/{tenant}/contact-events

Oprávnenie: modul campaigns, úroveň full; kľúč s prístupom full · Nástroj MCP: record_contact_event (cez MCP len s náhľadom a potvrdením)

Records an event of an existing contact (never creates one) for the event triggers of automations: type custom {name, data}, cart {shopId, items, currency, total} or visit {shopId, url, visitType, attributes}. At most 60 events of one contact in 10 minutes.

An event of an existing contact (contactId or email) for the event triggers: type custom {name, data}, cart {shopId, items, currency, total} or visit {shopId, url, visitType, attributes}. Never creates a contact. 201 {id}; 429 rate_limited after contact_events.API_PER_CONTACT events of one contact in API_WINDOW_S.

Parametre

Telo požiadavky (application/json)

Odpovede

• 201 Created: application/json object

Chyby

Schémy#

Automation#

AutomationCounts#

AutomationDetail#

AutomationEdge#

A connection from an output (branch) of source to target. Every output has at most one edge; no edge into a trigger or goal; no cycles.

AutomationEditorData#

GET /tenants/{t}/automations/{id}/editor: everything the editor opens with, in one answer. A catalog of a module the user cannot read (its list endpoint would answer 403) is empty.

AutomationEditorList#

A list as the editor's pickers and checks need it (no member counts).

AutomationEditorOption#

An option of an editor picker: id and name only.

AutomationEmailNode#

An e-mail node of another automation (events and conditions may name it: "e-mailový uzel / název scénáře").

AutomationGraph#

The graph: at most 300 nodes and 600 edges, one or more triggers, acyclic. An output without an edge = the contact leaves.

AutomationInput#

AutomationIssue#

A problem of a graph. Errors refuse the save (400 validation graph, params.issues); incomplete settings are saved but block activation and tests (detail.issues).

AutomationNode#

One node of an automation graph; type selects the settings in config. Unknown config keys are dropped when saving.

AutomationNode_trigger_now or AutomationNode_trigger_scheduled or AutomationNode_trigger_repeat or AutomationNode_trigger_event or AutomationNode_trigger_date or AutomationNode_trigger_reorder or AutomationNode_condition or AutomationNode_wait or AutomationNode_ab_test or AutomationNode_holding or AutomationNode_goal or AutomationNode_send_email or AutomationNode_send_sms or AutomationNode_list_change or AutomationNode_send_viber or AutomationNode_webhook or AutomationNode_set_field or AutomationNode_reset or AutomationNode_fb_audience or AutomationNode_sklik_retargeting or AutomationNode_motionlab_adina or AutomationNode_whatsapp or AutomationNode_fire_event or AutomationNode_notify or AutomationNode_goto or AutomationNode_end

AutomationNodeCounts#

AutomationNodeMeta#

AutomationNodeTest#

AutomationNodeType#

one of: notify, trigger_now, trigger_scheduled, trigger_repeat, trigger_event, trigger_date, trigger_reorder, condition, wait, ab_test, holding, goal, send_email, send_sms, list_change, send_viber, webhook, set_field, reset, fb_audience, sklik_retargeting, motionlab_adina, whatsapp, fire_event, goto, end

AutomationNode_ab_test#

Splits contacts randomly (stable per run) into 2 to 10 variants; outputs v1..vN.

{
  "id": "ab-test-1",
  "type": "ab_test",
  "config": {
    "variants": [
      {
        "key": "v1",
        "share": 50
      },
      {
        "key": "v2",
        "share": 50
      }
    ]
  }
}

AutomationNode_condition#

Splits the run: output yes when the definition holds, else no. With waitUntilMet the contact waits until it holds (then yes) or the time runs out (then no); checked every 20 minutes to once a day.

{
  "id": "condition-1",
  "type": "condition",
  "config": {
    "definition": {
      "type": "group",
      "match": "all",
      "rules": [
        {
          "type": "email_activity",
          "operator": "opened",
          "nodeId": null
        }
      ]
    }
  }
}

AutomationNode_end#

Ends the run (the contact leaves).

{
  "id": "end-1",
  "type": "end",
  "config": {}
}

AutomationNode_fb_audience#

Not available yet: needs meta. Shown in the palette, saving reports "unavailable".

AutomationNode_fire_event#

Fires a custom event of the contact that event triggers (custom) of OTHER automations listen to.

{
  "id": "fire-event-1",
  "type": "fire_event",
  "config": {
    "name": "vip-reached",
    "data": {
      "level": "gold"
    }
  }
}

AutomationNode_goal#

Goal of the scenario: before every step the goals are checked; a contact who meets one leaves the scenario wherever it is. No edges in or out.

{
  "id": "goal-1",
  "type": "goal",
  "config": {
    "definition": {
      "type": "group",
      "match": "all",
      "rules": [
        {
          "type": "ordered_since_entry",
          "operator": "yes",
          "shopId": null
        }
      ]
    }
  }
}

AutomationNode_goto#

Jumps to another node of this graph (not a trigger or goal; the jump counts as an edge for cycles, so only forward).

AutomationNode_holding#

Storage (Odkladiště): contacts wait here until an edge out of the node is added (then they continue) or 90 days pass.

{
  "id": "holding-1",
  "type": "holding",
  "config": {}
}

AutomationNode_list_change#

Sets the contact's state in manual lists (confirmed adds, unsubscribed and removed take out). Lists bound to an e-shop cannot be changed.

{
  "id": "list-change-1",
  "type": "list_change",
  "config": {
    "status": "confirmed",
    "listIds": [
      "101"
    ]
  }
}

AutomationNode_motionlab_adina#

Not available yet: needs motionlab. Shown in the palette, saving reports "unavailable".

AutomationNode_notify#

Notifies the team in the app (notification centre).

{
  "id": "notify-1",
  "type": "notify",
  "config": {
    "message": "Zákazník dosáhl VIP úrovně",
    "important": false
  }
}

AutomationNode_reset#

Ends the contact's other active runs of this scenario that wait in nodes after this one (SmartEmailing Reset).

{
  "id": "reset-1",
  "type": "reset",
  "config": {}
}

AutomationNode_send_email#

Sends an e-mail from a template (once per node and contact within the company's window). Only to mailable contacts, rechecked right before sending.

{
  "id": "send-email-1",
  "type": "send_email",
  "config": {
    "templateId": "301",
    "subject": "Zapomněli jste něco v košíku",
    "trackOpens": true,
    "trackClicks": true
  }
}

AutomationNode_send_sms#

Not available yet: needs sms. Shown in the palette, saving reports "unavailable".

AutomationNode_send_viber#

Not available yet: needs viber. Shown in the palette, saving reports "unavailable".

AutomationNode_set_field#

Sets or clears a contact field. valueKind fixed (a value of the field's type), relative (dates: a time spec from now) or template (text fields: merge tags).

{
  "id": "set-field-1",
  "type": "set_field",
  "config": {
    "field": "cf:62",
    "action": "set",
    "valueKind": "fixed",
    "value": "VIP"
  }
}

AutomationNode_sklik_retargeting#

Not available yet: needs sklik. Shown in the palette, saving reports "unavailable".

AutomationNode_trigger_date#

Starts once a day at at for contacts whose date is today: name day, birthday, a date custom field (shifted by offsetDays), fixed holidays (every contact of the shop), or the first completed order exactly days ago.

{
  "id": "trigger-date-1",
  "type": "trigger_date",
  "config": {
    "kind": "name_day",
    "at": "08:00",
    "reentry": "parallel"
  }
}

AutomationNode_trigger_event#

Starts when an event happens to a contact (SmartEmailing "Při události"). Only events after the activation count. Event specific settings: cart_updated: The contact's cart changed (POST /contact-events type cart). shopId narrows the shop. contact_created: A new contact of the automation's shop. order_created: A new order (shopId: shop of the order, default the automation's shop). order_changed: An order changed state (state narrows to one state). list_added: The contact was added to listId. contact_updated: A profile field changed (fieldFilter narrows to one field and its values before / after). action_failed: An action of an automation failed (failureType, failureNode narrow it). list_status_changed: The contact's state in listId changed to status. email_sent: An e-mail of emailNode (a send_email node of ANOTHER automation) was sent. page_visit: A web tracking visit (POST /contact-events type visit): url, urlOperator, visitType. link_clicked: The contact clicked a link (link, compareParams) in an e-mail of emailNode (another automation). engagement_changed: The contact's engagement level changed. custom: A custom event named customEvent (POST /contact-events type custom, or a fire_event node of another automation). form_submitted: A form was submitted and confirmed (formId narrows to one form). blacklisted: The contact was blacklisted. order_completed: An order was completed (paid, shipped or delivered). subscribed: The contact subscribed (sources narrows the source; imports only when listed). manual: Contacts added by hand: POST /automations/{id}/contacts.

{
  "id": "trigger-event-1",
  "type": "trigger_event",
  "config": {
    "event": "cart_updated",
    "shopId": "1",
    "reentry": "restart"
  }
}

AutomationNode_trigger_now#

Starts once, right at the activation, with the contacts of the shop matching the filter (SmartEmailing "Hned teď").

{
  "id": "trigger-now-1",
  "type": "trigger_now",
  "config": {
    "reentry": "once"
  }
}

AutomationNode_trigger_reorder#

Starts once a day at at for customers whose last completed order is older than their usual interval between orders ("buy again"): the average gap of their order days, defaultDays with one order day, clamped to minDays..maxDays, plus graceDays.

{
  "id": "trigger-reorder-1",
  "type": "trigger_reorder",
  "config": {
    "at": "10:00",
    "defaultDays": 30,
    "minDays": 14,
    "maxDays": 120,
    "graceDays": 3,
    "reentry": "parallel"
  }
}

AutomationNode_trigger_repeat#

Starts repeatedly every every from startAt (default the activation) until stopAt, with the contacts matching the filter (SmartEmailing "Opakovat").

{
  "id": "trigger-repeat-1",
  "type": "trigger_repeat",
  "config": {
    "every": {
      "value": 1,
      "unit": "days"
    },
    "startAt": "2026-11-01T08:00",
    "reentry": "parallel",
    "filter": {
      "type": "group",
      "match": "all",
      "rules": [
        {
          "type": "contact_anniversary",
          "field": "nameDay",
          "relation": "now"
        }
      ]
    }
  }
}

AutomationNode_trigger_scheduled#

Starts once at a local date and time (SmartEmailing "V plánovaný čas").

{
  "id": "trigger-scheduled-1",
  "type": "trigger_scheduled",
  "config": {
    "at": "2026-12-01T09:00",
    "reentry": "once"
  }
}

AutomationNode_wait#

Waits. mode time: until the time spec (relative to the arrival at the node, or to the entry with countFrom scenario); preferred: until the contact's usual reading time (most frequent quarter hour of opens, else no wait); spread: releases the contacts evenly over the period; duration: value units; time_of_day: the next HH:MM; weekday: the next listed weekday at time; date: a local date and time. At most 10 years.

{
  "id": "wait-1",
  "type": "wait",
  "config": {
    "mode": "duration",
    "value": 2,
    "unit": "days"
  }
}

AutomationNode_webhook#

Calls a URL (queued, retried 5 times 5 minutes apart on a non-2xx answer, then an action failure "other"). Merge tags work in url (percent-encoded), body (JSON-escaped when the Content-Type is JSON; POST defaults to application/json) and header values. Only public addresses, no redirects.

{
  "id": "webhook-1",
  "type": "webhook",
  "config": {
    "url": "https://crm.example.cz/hooks/postarna",
    "method": "POST",
    "body": "{\"email\": \"{{df_emailaddress}}\", \"event\": \"cart\"}",
    "headers": [
      {
        "name": "X-Source",
        "value": "postarna"
      }
    ]
  }
}

AutomationNode_whatsapp#

Not available yet: needs whatsapp. Shown in the palette, saving reports "unavailable".

AutomationPass#

A contact that went through a node (SmartEmailing's "Kontakty, které prošly uzlem").

AutomationReport#

AutomationReportRow#

Statistics of a scenario: one row per e-mail node (metrics as the e-mail statistics), conversions per currency.

AutomationRun#

AutomationRunStatus#

one of: active, completed, exited

AutomationStats#

AutomationStatus#

one of: active, draft, paused

AutomationStepOutcome#

one of: expired, queued, failed, skipped, goal, reset, end, yes, no, entered, passed, variant, released, jumped

AutomationTest#

POST /automations/{id}/test: one dry pass over the current data; nothing is written or sent.

AutomationTestInput#

AutomationTestScope#

one of: contacts, events, today, mixed

AutomationTrace#

AutomationTraceInput#

AutomationTraceStep#

POST /automations/{id}/trace: the way of one contact through the scenario, nothing written or sent.

AutomationValidation#

AutomationVersion#

A saved version of a graph (every save keeps one).

ConditionGroup#

The definition of a condition, goal or trigger filter: the same tree as a segment, whose rules may also be automation conditions. Every rule may carry negate. Rules with a period take {from, to} time specs.

ConditionRule_ab_test_significant#

The difference between nodes A and B is significant (95 %, two-proportion z-test).

ConditionRule_ab_test_winner#

Node A beats node B (two send_email nodes of this graph) in open or click rate.

ConditionRule_cart_items#

Old name of cart_items_count (still accepted).

{
  "type": "cart_items",
  "operator": "gt",
  "value": 0
}

ConditionRule_cart_items_count#

Items in the contact's cart (a cart not changed since an order counts as empty).

{
  "type": "cart_items_count",
  "operator": "gt",
  "value": 0,
  "shopId": "1"
}

ConditionRule_contact_anniversary#

Today is (or is offset from) the contact's birthday, name day or a date custom field. nameDay: the contact's own name day, else the calendar of the first name (calendar auto = Slovak for language sk, else by the shop's language).

{
  "type": "contact_anniversary",
  "field": "nameDay",
  "calendar": "auto",
  "relation": "now"
}

ConditionRule_contact_field#

A contact field (system field or cf:<id>) compared with a value. Text: eq, filled, empty, gt, gte, lt, lte, starts, contains; dates: date_eq, date_filled, date_empty, date_after, date_from, date_before, date_until with a time spec value; numbers: eq, gt, gte, lt, lte, filled, empty; gender: eq (f / m); checkbox: checked, unchecked; choice: eq_option; multi: has_option.

{
  "type": "contact_field",
  "field": "city",
  "operator": "eq",
  "value": "Brno"
}

ConditionRule_contact_in_any_list#

Contact is in any list in a state.

{
  "type": "contact_in_any_list"
}

ConditionRule_contact_in_automation#

Contact is in an automation (another active run of it). automationId null = this automation (not allowed in a trigger filter).

{
  "type": "contact_in_automation",
  "automationId": "201"
}

ConditionRule_contact_in_list#

Contact is in a list in a state.

{
  "type": "contact_in_list",
  "listId": "101",
  "state": "confirmed"
}

ConditionRule_contact_in_list_label#

Contact is in a list with this label.

{
  "type": "contact_in_list_label",
  "label": "newsletter"
}

ConditionRule_contact_origin#

Contact came from a source.

{
  "type": "contact_origin",
  "origin": "signup_form"
}

ConditionRule_contact_preference#

Not available yet: Poštárna has no preferences data. Saving a graph with it reports "unavailable".

ConditionRule_contact_purpose#

Contact has a valid consent with a purpose.

{
  "type": "contact_purpose",
  "purposeId": "51"
}

ConditionRule_contact_viber_state#

Not available yet: Poštárna has no viber data. Saving a graph with it reports "unavailable".

ConditionRule_day_of_month#

Today is one of these days of the month.

{
  "type": "day_of_month",
  "days": [
    1,
    15
  ]
}

ConditionRule_day_of_week#

Today is one of these weekdays (1 = Monday).

{
  "type": "day_of_week",
  "weekdays": [
    6,
    7
  ]
}

ConditionRule_delivered_viber#

Not available yet: Poštárna has no viber data. Saving a graph with it reports "unavailable".

ConditionRule_email_activity#

The contact opened / clicked an e-mail of this run (nodeId null = any). Run only. (not allowed in trigger filters (needs a run))

{
  "type": "email_activity",
  "operator": "opened",
  "nodeId": null
}

ConditionRule_engagement_score#

Engagement level of the contact.

{
  "type": "engagement_score",
  "levels": [
    "A",
    "B"
  ]
}

ConditionRule_event_attribute#

A value of the data of the custom event that started the run (data of POST /contact-events type custom, or of a fire_event node of another automation). Other triggers have no such data. Run only. (not allowed in trigger filters (needs a run))

{
  "type": "event_attribute",
  "attribute": "plan",
  "operator": "eq",
  "value": "gold"
}

ConditionRule_feed_item_count#

Number of items of a feed.

{
  "type": "feed_item_count",
  "feedId": "71",
  "operator": "gt",
  "value": 0
}

ConditionRule_hour_of_day#

The current hour (local) is one of these.

{
  "type": "hour_of_day",
  "hours": [
    8,
    9,
    10
  ]
}

ConditionRule_opened_email#

The contact opened an e-mail of a node.

{
  "type": "opened_email",
  "emailNode": {
    "automationId": "201",
    "nodeKey": "email-1"
  }
}

ConditionRule_opened_emails_count#

Number of e-mails the contact opened.

{
  "type": "opened_emails_count",
  "operator": "eq",
  "value": 0
}

ConditionRule_ordered_attribute#

A value of an order: code, state, status, sourceStatus, currency, companyId, totalWithVat, totalWithoutVat, or any delivery data field.

{
  "type": "ordered_attribute",
  "attribute": "currency",
  "operator": "eq",
  "value": "CZK"
}

ConditionRule_ordered_product#

The contact ordered a product by id (product code) or name.

{
  "type": "ordered_product",
  "productField": "id",
  "operator": "eq",
  "value": "SKU-001"
}

ConditionRule_ordered_product_by_attribute#

The contact ordered a product with a feed attribute.

{
  "type": "ordered_product_by_attribute",
  "attribute": "brand",
  "operator": "eq",
  "value": "Example"
}

ConditionRule_ordered_since_entry#

The contact ordered since the run entered. Run only. (not allowed in trigger filters (needs a run))

{
  "type": "ordered_since_entry",
  "operator": "yes",
  "shopId": null
}

ConditionRule_orders_count#

Number of orders.

{
  "type": "orders_count",
  "operator": "eq",
  "value": 1,
  "paid": "any"
}

ConditionRule_orders_total_value#

Sum (or avg, min, max) of the contact's orders with VAT in one currency.

{
  "type": "orders_total_value",
  "operator": "gte",
  "value": "3000",
  "currency": "CZK"
}

ConditionRule_passed_node#

This run went (or did not go) through a node. Run only. (not allowed in trigger filters (needs a run))

ConditionRule_promo_code#

The contact got (assigned) or used a coupon of a stack.

{
  "type": "promo_code",
  "state": "used",
  "stackId": "81"
}

ConditionRule_score#

Not available yet: Poštárna has no scoring data. Saving a graph with it reports "unavailable".

ConditionRule_script#

A Twig script; true when it prints {{ result.returnTrue() }}. Not allowed in trigger filters. (not allowed in trigger filters (needs a run))

{
  "type": "script",
  "script": "{% if contact.city == 'Brno' %}{{ result.returnTrue() }}{% endif %}"
}

ConditionRule_seen_viber#

Not available yet: Poštárna has no viber data. Saving a graph with it reports "unavailable".

ConditionRule_sent_email#

An e-mail was sent to the contact: of one node (mode node) or of an automation (mode automation, automationId null = any).

{
  "type": "sent_email",
  "mode": "node",
  "emailNode": {
    "automationId": "201",
    "nodeKey": "email-1"
  }
}

ConditionRule_sent_emails_count#

Number of e-mails sent to the contact.

{
  "type": "sent_emails_count",
  "operator": "gte",
  "value": 3
}

ConditionRule_sent_sms#

Not available yet: Poštárna has no sms data. Saving a graph with it reports "unavailable".

ConditionRule_tracking_url_clicked#

The contact clicked a link in an e-mail of a node.

{
  "type": "tracking_url_clicked",
  "emailNode": {
    "automationId": "201",
    "nodeKey": "email-1"
  },
  "link": "https://www.example.cz/akce"
}

ConditionRule_tracking_url_clicked_any#

The contact clicked any link of a node (emailNode null = any e-mail node of this automation).

{
  "type": "tracking_url_clicked_any",
  "emailNode": null
}

ConditionRule_visited_attribute#

A web tracking visit with an attribute.

{
  "type": "visited_attribute",
  "attribute": "category",
  "operator": "eq",
  "value": "Káva"
}

ConditionRule_visited_url#

A web tracking visit of a URL.

{
  "type": "visited_url",
  "url": "https://www.example.cz/kosik",
  "urlOperator": "starts"
}

EmailMetrics#

Counts of e-mails and their events (server core/stats.py). Rates as SmartEmailing: openRate, unsubscribeRate and complaintRate over the delivered e-mails, ctr and bounceRate over the sent ones; ctor = unique clicks / unique opens. Test e-mails never count.