Skip to main content

Voyado Engage

Automation custom triggers

Automation enable you to create individual marketing journeys for every customer. Events such as purchases, birthdays etc can act as triggers and lead to several automated activities depending on specific data.

Custom triggers

Apart from the built-in standard triggers, that take action from internal Voyado events, it’s possible to set-up custom triggers. Custom triggers is a way for other systems to trigger Voyado to start an automation.

Example of a custom trigger automation flow

customtriggerautomation.png

Theres no limit to the amount of custom triggers we can set up in a Voyado installation.

  • A custom trigger is called using the triggerName and the user contactId (GUID) or some other key, see API-reference below.

  • A custom trigger can receive JSON data (data fields), defined per specific trigger.

The field definitions and the triggerName are configured by the Voyado team. The data fields can be used to filter the automation and as variable data in the content produced in the automation.

API

Base URL: /api/v2/automation/customTriggers/[triggerName]

A custom trigger can only be triggered for an existing contact in Voyado. These are the different integration keys for connecting the call to the specific contact. The choice of key should be decided in collaboration with your Voyado contact.

  • {base-url}/triggerByContactId/{contactId}

  • {base-url}/triggerByContactTypeAndKey/{contactType}/{keyValue}

  • {base-url}/triggerByExternalContactId/{externalId} (typically the unique id from the triggering system)

  • {base-url}/triggerBySocialSecurityNumber/{ssn}

Endpoint/api/v2/automation/customTriggers/

Payload example

Custom triggers is often used for transactional communication from ECOM or the business layer to the customer. This example payload is used to populate a reset password email.

{
"oldAccount":"true" OR "false",
"username":"[username]"
"resetUrlHTML":"[http-adress of unique reset link]"
}

In this example the “oldAccount” flag can be used to filter different kinds of communication or trigger a specific automation. All automation flows using a certain trigger will listen for any responding API call but only the responding data sent in the payload will start the specific automation flow.