Articles on: Getting Started

Terms Reference

Action - An action is a step in your flow. For example, 'Send Message'. 'Update the Contact', and 'Enter Another Flow' are actions.

Administrator Role - An account administrator has complete control over a workspace. They can change settings, add or delete additional logins, & more. Admins can access & edit all aspects of your workspace including flows, campaigns, contacts, and messages.

Campaign & Campaign Event - Campaigns allow you to schedule messages and workflows relative to a date for a contact, such as the date a contact was created or the date a contact joined a group. A campaign event is the specific message or flow to be started within a campaign.

Channel - Channels allow you to send and receive messages or phone calls through your workspace. Examples of channels include SMS, WhatsApp, Facebook Messenger, and Telegram. You can add multiple channels to your workspace, including multiple channels of the same type.

Classifier - Classifiers allow you to interpret free text within a flow to extract relevant pieces of information.

Contact - A contact is an end-user that has interacted or will interact with your account.

Contact Field - Each contact can be assigned attributes, called contact fields, that hold values such as their names, phone numbers, and any other individual information you want to include.

Dashboard - The dashboard within your workspace gives you an overview of incoming and outgoing messages in a weekly, monthly, yearly or all view.

Editor Role - Editors can edit flows, campaigns, triggers and contacts, send messages, start flows, export flows, contacts and messages, and export/import flows. Editors cannot make changes to the account's home page, including managing account roles, changing language or timezone settings, and adding and removing channels.

Expression - Expressions allow you to customize messages in your flows. For example, you can perform arithmetic or use built-in functions which can be used to perform more complex tasks like formatting dates and times.

Flow - A flow is a visual representation of conditional branch logic that's applied to your contacts once they enter the flow.

Flow Editor - The flow editor is where you build and edit your flows. You can enter the editor for each individual flow by visiting the 'Flows' tab and clicking on the flow name.

Flow Event - You can create flow events which external services can subscribe to. For example, Zapier can subscribe to flow events you create and trigger any number of Zapier integrations when they occur in your flows.

Global Variable - A global variable is a shared value that can be used across your account, making the reference of frequently used values much simpler.

Label - You can create labels for flows, messages, and responses to better organize the data in your workspace.

Logs - You can see channel message and call logs to view all messages and calls sent and received via a specific channel by clicking on the channel section in your workspace account page, flow start logs to see when flows were started and by whom, or the message history logs for individual contacts.

Login - A login is a unique user in your workspace.

Node - A node is a step in your flow. This can either be an action or a split action.

Node Exits - Node exits refer to the routes that contacts can take in your flow logic. These are represented as dots at each exit with a red dot meaning that the contact will be removed from the flow.

Outbox - Occasionally, errors can occur with your channels. When this happens, messages may not send properly and will go to your outbox where they are queued to be sent.

Parent & Child Flows - Within a flow, you can Enter another flow. The original flow is called the "parent" and newly started flow is the "child". This action is useful when you wish for a contact to pass through a different flow before moving forward in the parent flow. Once the child flow is completed, the contact will return to the parent flow.

Parent & Child Variables - In child flows, entered through the Enter Another Flow action, @parent can be used to reference the flow result fields collected in the previous (parent) flow, e.g. @parent.field. Likewise, @child can be placed in the parent flow to reference flow fields collected by the child flow up to the point the contact either finished the child flow or expired from it.

Results - Results give you an overview of your flow, analytics on messages and runs & data on all activity in your flow- start to finish.

Run - Passage through a flow from entrance to exit - and all activity that takes place in between - constitutes a run. Contacts exit a flow when they complete the flow, start another flow via the Enter Another Flow action, or expire from the flow after the period of inactivity you designate.

Start a Flow - Start a flow manually from within the flow editor with the 'Start Flow' button, via a keyword trigger, on a schedule or in the future, as part of a campaign, or after receiving a call.

Surveyor Role - Surveyors have no administrative privileges, nor can they access the account. They may only submit flow results via our offline flow-based data collection mobile Nyaruka Surveyor apps.

Ticketing Service - Add an Email or Zendesk ticketing service to your account to pass communications to human agents.

Trigger - Triggers allow you to control how or when a flow begins. A flow can be triggered by a keyword, when receiving or missing a call, when receiving a message not handled elsewhere, when a contact initiates a conversation, or when Facebook refers a contact. A trigger can schedule a flow to start on a future date and also allow contacts to join a group.

URN - A URN is an address for your contact. These include phone number, email, and more. A single contact can have multiple URNs.

Variable - Variables are used to reference values such as @contact.first_name or @urns.mailto. These can be contact variables like name or group, URNs like phone number, response results in a flow, external variables passed from Zapier or a webhook, and global variables that are shared values across your workspace. See our entire reference guide here.

Viewer Role - Viewers can see every aspect of the account, but may not modify anything. This means that they cannot edit any aspect of the account, such as flows or contacts nor send messages.

Workspace - Your workspace is the name of your main account and you can have multiple child workspaces within. It is where you will manage your flows, contacts, and messages.

Ticketing Ticketing makes it easy to escalate contacts from automated flows with human agents, which means your team can assign, respond to, and close tickets, all without ever leaving your workspace.

Updated on: 22/01/2024

Was this article helpful?

Share your feedback


Thank you!