Skip to main content

Managing custom effects

Important

Only admins have access to this feature.

You can create custom effects to use them in your rules.

For example, you can create an effect to display all the basic details of a campaign and inform the customer what promotions they are eligible for.

Listing custom effects

  1. Click Account in the left-most menu.
  2. Click Tools > Custom Effects.

This page displays the available custom effects. It contains the following information for each of them:

ColumnDescription
IDUnique number identifying the custom effect. It can be used for integration purposes.
TitleName and description of the custom effect.
AppsNumber of Applications the custom effect is connected to.

Creating a custom effect

  1. Click Account in the left-most menu.
  2. Click Tools > Custom Effects.
  3. Click Create Custom Effect at the top-right of the page.
  4. In Properties, choose:
    • API name: The API name of the custom effect as it will appear in API requests.
    • Rule Builder name: The name of the custom effect as it will appear in the Rule Builder.
    • Custom effect description: A description of what the custom effect does.
    • Applications: Applications where the custom effect will be available.
  5. In Parameters, choose:
    • Param type: The type of parameter (string, number, boolean, time).
    • Param name: The name of the parameter.
    • Param description: A description of the parameter.
  6. In Effect payload, type the payload to send in the effect.
  7. Click Create.

The custom effect becomes available in the Rule Builder for all the campaigns in the connected Applications.

See the tutorial.

Editing custom effects

You can modify some characteristics of a custom effect after it has been created. For example, you can make it available in different Applications.

  1. Click Account in the left-most menu.

  2. Click Tools > Custom Effects

  3. Click the name of the custom effect you want to edit.

  4. Edit the required details.

    Important

    You cannot modify the paramenters of a custom effect if you are using it.

  5. Click Save.

Deleting custom effects

You can delete any unused custom effects.

  1. Click Account in the left-most menu.
  2. Click Tools > Collections.
  3. Click the name of the custom effect you want to delete.
  4. Click Delete Custom Effect at the top-right of the page.
  5. Click Delete <custom effect name> in the confirmation pop-up that appears.