Trigger Definition

Updated 5 days ago by Hallie

A trigger is an event that will initiate the flow. Users can choose from a list of built-in triggers as well as triggers that are exposed by various connectors.

Triggers may carry some initial data that can be used as an input of later actions in the flow.

Here is the list of available triggers:

  • Incoming Call to Phone Numbers - Voice
  • Automated Flow Using Cron - Timer
  • ​Call Detail Updated - Call Detail
  • ​Call Ended - Wallboard
  • Call Transferred to Flow - Wallboard
  • ​Campaign Completed - Wallboard Campaign Event
  • Campaign Ready - Walllboard Campaign Event​
  • ​Scheduled Campaign Ended - Wallboard Campaign Event
  • Scheduled Campaign Paused - Wallboard Campaign Event
  • ​Incoming Call Handler - Open API
  • Outgoing Call - Open API

  1. Incoming Call to Phone Numbers - Voice

Triggers flow when there is an incoming call to a number assigned to flow.

  1. Automated Flow Using Cron - Timer

Triggers flow automatically with cron expression.

Cron expression is a string consisting of six or seven subexpressions (fields) that describe individual details of the schedule. These fields, separated by white space, can contain any of the allowed values with various combinations of the allowed characters for that field.
  • Example:
    • 0 0 12 * * ? : trigger at 12pm (noon) every day.
    • 0 15 15 * * ? 2021 : trigger at 3:15pm every day during the year 2021.

  1. Call Detail Updated - Call Detail

Triggers flow when call details from other communication applications within this organization are available.

  1. Call Ended - Wallboard

Triggers flow when a call in any Wallboard outbound call campaigns ended.

  1. Call Transferred to Flow - Wallboard

Triggers flow when a call to other communication applications within this organization is transferred to this flow .

  • 2 ways to transfer a call to Flow:
    • Using Flow Trigger Code: Whenever you want to transfer a call to this flow, press ##2_trigger_code


    • Using Wallboard Outbound Call Campaign: Once the Wallboard Outbound Call Campaign handled by integrated queue is started, flow will be triggered accordingly.
      • In order to create a Wallboard Outbound Call Campaign and trigger a flow in Flow App, follow these steps below:

        • Step 1: Go to Flow app > click (+) icon to create a new flow > choose From Scratch to create a custom flow > select trigger: Call Transferred to Flow - Wallboard > create the list of actions as you wish > Activate.
          .
        • Step 2: Go to Wallboard app > Queue Management > Create Queue > Choose Type: Flow Integration > Select the flow created at step 1 > Create.
          Click HERE for more details.

        • Step 3: Go to Wallboard app > Number List > Create Number List > assign to the integrated queue created in step 1 > Upload the number list for your outbound call campaign.
          Click HERE for more details.

        • Step 4: Start your campaign.
          Click HERE for more details.

  1. Campaign Completed - Wallboard Campaign Event

Triggers flow when any of the Wallboard Outbound Campaigns started immediately is finisned (both campaign handled manually and campaign handled by integrated Flow).

  1. Campaign Ready - Walllboard Campaign Event

Triggers flow when any of the Wallboard Outbound Campaigns started immediately is finisned (both campaign handled manually and campaign handled by integrated Flow).

  1. Scheduled Campaign Ended - Wallboard Campaign Event

Triggers flow when any of the scheduled Wallboard Outbound Campaigns is ended (both campaign handled manually and campaign handled by integrated Flow).

  1. Scheduled Campaign Paused - Wallboard Campaign Event

Triggers flow when any of the scheduled Wallboard Outbound Campaigns is paused (both campaign handled manually and campaign handled by integrated Flow).

  1. Incoming Call Handler - Open API

This trigger receives an incoming call request from Open API and starts a flow. It can only be triggered when receiving input data (TXN UUID and Flow UUID) from Open API. Usually used by the developers.

TXN UUID: Call Transaction UUID taken from the notification of Flow 1.
Flow UUID: Flow UUID of Flow 2.

Example:

Requirements:

When there is an incoming call to developer's purchased number: +61730630xxx, a notification (including call details) will be sent to developer's Webhook endpoint. After receiving the notification, developer will call Incoming Call Open API to connect the caller to number +6561234567 with caller ID: +61730630xxx.

In order to create a flow that can fulfil this request, follow the steps below:

1. Create flow 1:

  • Step 3: Click Activate to make this flow active

2. Create flow 2:

  • Step 1: Create a new flow with trigger: Incoming Call Handler - Open API

  • Step 2: Add Voice Connector Action: Connect Call
  • Step 3: Click Activate to make this flow active

  • Step 4: Copy UUID of Flow 2 and paste it to your webhook, following the Open API below

TXN UUID: Call Transaction UUID taken from the notification of Flow 1.
Flow UUID: Flow UUID of Flow 2.

  1. Outgoing Call - Open API

This trigger receives an outgoing call request from Open API and starts a flow. It can only be triggered when receiving input data (Idempotency Key, Flow UUID, Destination and Payload-optional) from Open API. Usually used by the developers.

Example:

Requirements:

When developer calls Outgoing Call Open API, the system will call number +6582345678 with caller ID: +6567777777 (developer's purchased number). Once +6582345678 picks up the call, message A will play to +6582345678. After the message, the system will connect +6582345678 with number +6532109876 but with caller ID: +6567777777.

=> By doing this, +6582345678 and +6532109876 will not know the real number of each other. They only see +6567777777 as caller ID.

In order to create a flow that can fulfil this request, follow the steps below:

  • Step 1: Create a new flow with trigger: Outgoing Call - Open API

  • Step 2: Add Voice Connector Action: Make Outgoing Call to make an outgoing call to a particular number and return the transaction UUID to an external server (webhook).

  • Step 3: Add Voice Connector Action: Play a Message to play a message to +6582345678

  • Step 4: Add Voice Connector Action: Connect Call to connect +6582345678 with number +6532109876 with caller ID: +6567777777.

  • Step 5: Click Activate to make this flow active


How did we do?


Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)