Triggers

Triggers enable the reception of signals (via API key webhook) whenever an account attains a predefined target balance or transaction count value. The Triggers functionality enables you to either select an existing trigger or create a new one for a new account-currency pair.

Creating and Adding a New Trigger

To create a new trigger, you have two options: you can do it either in the Actors bag section or within the Account menu. If you choose to create a new trigger from the Actors bag section, follow these steps:

1. Open the Actors bag section;
2. Click on All forms to access the forms drop-down menu;
3. Choose AccountTriggers from the list of available forms, or you can start typing "AccountTriggers" in the search field and select it when it appears;
4. Inside the Triggers menu, click on Create. This will open the window for creating a new trigger actor:

To create a new trigger from the Accounts menu, follow these steps:

1. Open the Accounts section;
2. Click on the specific account you need from the list to access the linked currencies;
3. Within the linked currencies list, open the account-currency menu by clicking on the menu symbol;
4. Select Manage Tags & Triggers from the menu;
5. In the Manage Tags & Triggers window, click on the Triggers field;
6. Click Create in the Triggers field:

You can also add an existing trigger to the account-currency pair by selecting it from the drop-down list in the Triggers field.

You can also create and add a new trigger or an existing trigger to a new account-currency pair when creating the pair. To do this, follow these steps:

1. Open the Accounts section;
2. Click Create to open the account creation window;
3. In the window, add the account currency names and click on the Triggers field;
4. Click Create in the Triggers field.

When creating a new trigger you can configure the following trigger parameters:

• Actor name (required) - trigger name;
• Account value type - allows selecting the value type by which the trigger will be activated:
  • Account amount (default) - sending the signal is triggered by checking a currency amount on the account;
  • Count of transactions - sending the signal is triggered by checking a count of transactions against the account;
• Account income type - allows selecting the type of operations or balance by which the trigger will send the signal:
  • Total - trigger for total account balance;
  • Debit - trigger for account debit operations;
  • Credit - trigger for credit account operations;
• Trigger end date - allows setting the date on which the trigger becomes inactive;
• Lower target value (required) - allows setting the lower limit exceeding which makes the trigger send a signal;
• Upper target value (required) - allows setting the upper limit exceeding which makes the trigger send a signal;
• Period name - allows selecting the period for checking the trigger target values (Day, Month, Quarter, Year);
• Period value -allows setting the number of selected periods for checking the trigger target values.

In the Access tab of the account-currency pair creation menu, you can set up access permissions for the pair and share it with the selected workspace users.

After you've configured trigger parameters, click Save to save the changes.

Operations on Triggers and Editing a Trigger

You can perform operations on triggers from the trigger menu. To open the menu, follow these steps:

1. Open the Actors bag section;
2. Navigate to the triggers list by selecting AccountTriggers in the drop-down menu labeled All forms;
3. In the triggers list, locate the trigger you want to perform operations with;
4. Open the trigger menu:

In this menu, you can:

• Make a copy of the trigger;
• Make multiple copies (up to 50) of the trigger;
• Add the trigger to the export graph queue;
• Delete the trigger.

To edit trigger settings, follow these steps:

1. Click on the trigger in the list to open trigger details;
2. In the details menu, navigate to the Details tab (which opens by default);
3. Click on the edit symbol located in the Form properties section. This will allow you to make changes to the trigger settings:

Removing a Trigger

Removing a trigger from an account-currency pair is similar to adding a trigger. You can do this by accessing the Triggers field in the Manage Tags & Triggers window of the account-currency pair and then clicking the remove icon of the trigger you want to remove:

After removing the needed triggers in the Triggers field click Save to save the changes to the account settings.

Removing a trigger from the Triggers field of an account does not delete the trigger from the workspace; it only deactivates the trigger for the selected account-currency pair. To completely delete a trigger from your workspace, follow these steps:

1. Open the Actors bag section;
2. Navigate to the triggers list by selecting AccountTriggers in the drop-down menu labeled All forms;
3. In the triggers list, locate the trigger you want to delete;
4. Open the menu of the trigger you want to delete and select Remove to delete the trigger permanently from your workspace.