Flows

name: Sync New Contacts
key: sync-new-contacts
nodes:
  contact-created:
    type: data-record-created-trigger
    name: Contact Created
    config:
      dataSource:
        collectionKey: contacts
    links:
      - key: transform-contact-data
  transform-contact-data:
    type: transform-data
    name: Transform Contact Data
    config:
      output:
        firstName:
          $var: input.contact-created.record.fields.firstName
        lastName:
          $var: input.contact-created.record.fields.lastName
        email:
          $var: input.contact-created.record.fields.email
    links:
      - key: send-contact-to-my-app
  send-contact-to-my-app:
    type: api-request-to-your-app
    name: Send contact to my app
    config:
      request:
        uri: https://myapp.com/api/new-contact
        method: POST
        body:
          contact:
            $var: $.input.transform-contact-data

​

Flow Structure

• name – Human-readable name of the flow.
• key – Name of the flow to use in your code (unique within a workspace)
• description – Optional description of what the flow does.
• nodes – A dictionary of nodes that make up the flow. Each node has a unique key and contains configuration for its behavior.
• parametersSchema – Schema of the flow parameters - useful for creating child flows from a parent template.
• parameters – Parameters of the flow (match parametersSchema)
• enabled – Whether the flow is enabled.
• parentUuid – UUID of the parent flow (when this flow was created from a parent flow)
• integrationUuid – UUID of the integration this flow is created for (only for flows that have an integration)
• connectionUuid – UUID of the connection this flow is created for (only for flows that have a connection)
• isCustomized – Whether the flow is customized compared to the parent (only for flows that have a parent)

​

Node Structure

• type – Node type that defines what the node does (see Node Types below).
• name – Human-readable name describing what this node does.
• config – Configuration specific to the node type.
• concurrency – Number of concurrent runs allowed for this node (default: 1).
• onError – Behavior when the node encounters an error: stop (default) or continue.
• links – Array of links to downstream nodes.

​

Links

• name – Optional name for the link.
• key – Key of the target node to connect to.
• filter – Optional filter to conditionally pass outputs to the target node. The value of the filter can use any formulas and has access to the same variables as the node’s configuration, with additional output variable available that represents output of the current node.

​

Node Types

​

Triggers

​

Function Nodes

​

Control Nodes

​

Inputs and Outputs

• Data from an API request (API Trigger)
• Data from an external app event (Data Record Created Trigger)
• Empty object for scheduled triggers (Schedule Trigger)
• Data from an internal app event (Internal Event Trigger)

{
  "trigger-key": {
    /* trigger output */
  },
  "transform": {
    "firstName": "John",
    "lastName": "Doe"
  }
}

​

Variables

• input - Initial flow input + outputs of all upstream nodes
• flowInstance - data of the current flow.
• flowRun - data of the current flow run.
• integration - data of the current integration
• connection - data of the current connection
• user - data of the current user
• parameters - parameters of the current flow

config:
  output:
    currentIntegrationId:
      $var: integration.id
    previousNodeOutput:
      $var: input.previous-node

​

Using Flows

​

API Operations