Transactional — Automation Node¶

Nodes are the steps of an automation. Each node has a type, a child (the next node, or null when the contact leaves the flow) and, for ifElse and externalEvent, a child2 (the second branch). A node's settings are kept in payload and are set with a PUT specific to its type.

Endpoints¶

Nodes are read with GET /transactional/<transactional>/automation/<automation>. Send the parameters form-encoded or in the query string.

Node types¶

POST /transactional/<transactional>/automation/<automation>/node¶

Creates a node and links it into the flow.

• Entry types (contactSignup, contactAnniversary, externalEventEntry, smsReceivedEntry) must be created with connectFrom=null&connectTo=null, and the other types must not. Otherwise the request fails with Incompatible type and position.
• A new entry node leads to the same first step as the existing entry nodes.
• To add a node between two nodes, set connectTo to the next node. With connectTo=null, attach only to a node or branch that has no next node yet.

Returns: The new node (transactionalAutomationNode) and the automation.

Example — add a sendMessage node after node 31:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "type=sendMessage&connectFrom=31&connectTo=null" \
  https://app.duo.pt/transactional/{transactional_id}/automation/{automation_id}/node

Response:

{
  "success": true,
  "data": {
    "transactionalAutomation": {
      "id": 7,
      "name": "Payment follow-up",
      "enabled": false,
      "send_transactional": 1
    },
    "transactionalAutomationNode": {
      "id": 32,
      "send_transactional_automation": 7,
      "type": "sendMessage",
      "title": "Receives a message",
      "comment": "Click to select message",
      "child": null,
      "child2": null,
      "payload": null
    }
  }
}

PUT /transactional/<transactional>/automation/<automation>/node/<node>/<type>¶

Sets the node's settings. <type> must be the node's type. Send a POST with x-verb=PUT. Each call replaces the whole payload.

Returns: transactional, transactionalAutomation and the updated transactionalAutomationNode, with its payload and a new comment.

contactSignup¶

Payload: {"segment": 5}

contactAnniversary¶

Payload: {"field_to_check": 42, "check_period": "year"}

externalEventEntry¶

Payload: {"event": "payment", "fields_to_set": []}

externalEvent¶

The parameters of externalEventEntry, plus:

Set a timeout only when you need the second branch.

wait¶

Payload: {"period": 86400}

sendMessage¶

Payload: {"message": 12}. The contact receives the message's email if it has an email address, and its SMS if it has a telephone number. Contacts that are not subscribed or are bouncing receive nothing but continue in the flow.

setField¶

Payload: {"fields_to_set": {"VIP": "43"}} (value → field ID). Each value can be used once per node: to write the same value in two fields, use two setField nodes.

ifElse¶

Payload: {"topoperator": "AND", "operands": [{"field": "45", "operator": "==", "operand": "yes"}]}. True → child, false → child2.

httpCallback¶

Send the four parameter…[] arrays with one entry per parameter, using empty values where they do not apply. A parameter with an empty name is ignored.

Payload: {"url": "https://example.com/duo/hook", "http_error": null, "http_result": 44, "http_parameters": [{"name": "email", "source": "field", "fieldValue": "email"}, {"name": "token", "source": "static", "staticValue": "s3cr3t"}]}

The request DUO makes: POST <url> with Content-Type: application/x-www-form-urlencoded and the parameters as body fields (no body if there are none), User-Agent: duo/<version>, and a 60-second timeout. A 2xx answer moves the contact to child. On any other answer, or if the request fails, the contact does not continue, unless http_error is set. Requests are not signed and not retried: put a secret token in a static parameter and check it on your side.

Example — configure an httpCallback node:

curl -u "username:api_key" -H "Accept: application/json" \
  --data-urlencode "x-verb=PUT" \
  --data-urlencode "url=https://example.com/duo/hook" \
  --data-urlencode "parameterName[]=email" --data-urlencode "parameterSource[]=field" \
  --data-urlencode "parameterStaticValue[]=" --data-urlencode "parameterFieldValue[]=email" \
  --data-urlencode "parameterName[]=token" --data-urlencode "parameterSource[]=static" \
  --data-urlencode "parameterStaticValue[]=s3cr3t" --data-urlencode "parameterFieldValue[]=" \
  --data-urlencode "http_error=" --data-urlencode "http_result=" \
  https://app.duo.pt/transactional/{transactional_id}/automation/{automation_id}/node/{node_id}/httpCallback

smsReceivedEntry, smsReceived¶

Payload: {"inbound_telephone": null, "set_field": {"field": 45, "source": "regex", "regex": "^YES (\\d+)"}, "timeout": 3600}

DELETE /transactional/<transactional>/automation/<automation>/node/<node>¶

Deletes the node. The nodes that pointed to it now point to its child. Deleting an ifElse or externalEvent node also deletes the first node of its second branch: delete the nodes of that branch first, from the last to the first.

Returns: transactional, transactionalAutomation and the deleted transactionalAutomationNode.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X DELETE \
  https://app.duo.pt/transactional/{transactional_id}/automation/{automation_id}/node/{node_id}