Skip to main content

Manage Custom Events and Custom Scheduled Events

Zuora

Manage Custom Events and Custom Scheduled Events

This article describes how to create, view, edit, clone, activate, inactivate, or delete custom events and custom scheduled events through the Zuora UI.

To manage custom events and custom scheduled events through the API, use the Custom Event Triggers and Custom Scheduled Events API operations.

View custom events and custom scheduled events

All custom events and custom scheduled events information is listed on the Custom Events page, including the name, description, type, base object, and status of each event.

To open the Custom Events page:

  1. Click your username in the upper right of the Zuora UI.
  2. Navigate to Settings > Billing, Settings > Finance, or Settings > Payments.
  3. Click Setup Profiles, Notifications and Email Templates
  4. Click the Custom Events tab.

You can narrow down the event items by using filters. For more information, see Reinvented list views.

To view the detailed page of a specific custom event or custom scheduled event, click the event name.

Create a custom event

To create a custom event:

  1. After you open the Custom Events page, click Create Custom Event.
  2. Enter the following information:
    • Name: Enter the display name of the custom event.
    • API Name: Enter the API name of the custom event. The name should be unique and contain no space.
    • Base Object: Select the base object that the custom event is defined on.
    • Description: Optionally, enter the description of the custom event.
    • Active: Switch this toggle to indicate whether the custom event should be triggered.
    • Set Conditions: Enter the expression in Java EXpression Language (JEXL). For more information about JEXL, see Define the trigger condition.
  3. Click Create.

After a custom event is successfully created, you can find it on the Custom Events page.

Create a custom scheduled event

To create a custom scheduled event:

  1. After you open the Custom Events page, click Create Custom Scheduled Event.
  2. Enter the following information:
    • Name: Enter the display name of the custom scheduled event.
    • API Name: Enter the API name of the custom scheduled event. The name should be unique and contain no space.
    • Base Object: Select the base object on which the custom scheduled event is defined.
    • Base Field: Enter the base field of the base object that the custom scheduled event is defined on. Note that this must be a date or timestamp format field and the value is case sensitive.
    • Hour: Enter the daily evaluation time (hour) of the custom scheduled event. The value should be an integer between 0 and 23.
    • Minute: Enter the daily evaluation time (minute) of the custom scheduled event.  The value should be an integer between 0 and 59.
    • Description: Optionally, enter the description of the custom scheduled event.
    • Active: Switch this toggle to indicate whether the custom scheduled event should be triggered.
    • Set Conditions: Optionally, enter the JEXL expression. For more information about JEXL, see Define the trigger condition.
  3. Optional: Specify any condition filter parameters you want to be enabled on the custom scheduled event.
    1. Click Add Parameter.
    2. Enter the following information for the new parameter:
      • Parameter Name: Enter the name of the parameter referenced in your condition.
      • Display Name: Enter the display name of the parameter.
      • Description: Optionally, enter a description of the parameter.
      • Options: Enter all available options for the parameter. Options should be separated by a new line.
      • Value Type: Select the value type of the parameter from the list.
    3. Repeat the steps above to add multiple parameters as needed. Click the trash can icon trash can.png in the upper right of the parameter to delete it.
  4. Click Create.

After a custom scheduled event is successfully created, you can find it on the Custom Events page.

Edit a custom event or a custom scheduled event

To edit an event:

  1. Click Edit of an event on the Custom Events page.
  2. Edit the desired fields of the event. The following fields are not editable:
    • Custom event: API Name and Base Object.
    • Custom scheduled event: API Name, Base Object and Base Field.
  3. Click Edit.

To activate or inactivate an event:

  1. On the Custom Events page, find the event you want to activate or inactivate.
  2. Click Activate or Inactivate of the event.
  3. Click Activate or Inactivate in the confirmation dialog. Then you can find the status of the event is updated to Inactive or Active in the Active column.

Delete a custom event or a custom scheduled event

To delete an event:

  1. Click the more options icon more options.png to the right of an event.
  2. Click Delete.
  3. Click Delete in the confirmation dialog. Then you can find that the event is removed from the Custom Events page.

Clone a custom event or a custom scheduled event

To clone an event:

  1. Click the more options icon more options.png to the right of an event.
  2. Click Clone.
  3. Enter a different API Name for the cloned event.
  4. Optional: Update other fields based on your requirements.
  5. Click Clone. Then you can find the cloned event on the Custom Events page.