Custom Events

Trigger condition syntax

Zuora uses the Apache Commons Java Expression Language (JEXL) library syntax for defining triggers. For more information, see Apache Commons JEXL.

Basically, a trigger condition consists of one or more sub-conditions connected by logical operators and must return a boolean value.

The following table lists the most common logical operators:

Sub-condition syntax

A sub-condition is an expression of two values connected by a comparison operator. The result of a sub-condition is also a boolean value.

Typically, the first operand is a dynamic value of an object field or a variable provided by Zuora, and the second operand is a fixed value. When changes to the base object occur, Zuora calculates the results of sub-conditions with the context data, for example, the related object record and changing type.

The following table lists variables you can use in sub-conditions:

Sub-conditions can contain fields only from the base object on which the event trigger is defined.

For more information about the available fields of each standard object, see Data Source Reference.

The following table lists the most common comparison operators:

JEXL also provides built-in functions (for example, size()) that can be used in sub-conditions. For all available operators and functions, see Apache Commons JEXL.

Examples

• changeType == 'INSERT'
  The event is triggered when a record of the base object is created.
• Account.Level__c == 'Premium'
  The event is triggered when a premium-level account is created, updated, or deleted. 
• changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0
  The event is triggered when an invoice is posted with an amount greater than 1000.
• (changeType == 'INSERT' || changeType == 'UPDATE') && size(default__vehicle.Serial__c) > 12
  The event is triggered when a record of the Vehicle custom object is created or updated, and the vehicle serial number is greater than 12 characters.
  In this example, two sub-conditions for change type are grouped by () because the boolean AND operator (&&) has higher precedence than the boolean OR operator (||).

Best practice for creating trigger conditions

It is recommended to use decimals when comparing numeric values. Using decimals helps prevent unexpected results when comparing an integer with a field that contains a decimal value.

For example, if you want to trigger an event when the Account object is updated and the account balance value is positive, use the following trigger condition:

changeType == 'UPDATE' && Account.Balance > 0.0

Otherwise, if you use Account.Balance > 0 in the trigger condition, the event might not be triggered because the Account.Balance field contains decimal values.

Bill Run Posted

You can use the following request sample to create a custom event of BillRunPosted if you do not use the auto-post on Bill Runs.

{
  "active": true,
  "baseObject": "BillingRun",
  "condition": "changeType == 'UPDATE' && BillingRun.Status == 'Posted' && BillingRun.Status_old != 'Posted'",
  "description": "Bill Run Posted",
  "eventType": {
    "name": "BillRunPosted",
    "displayName": "Bill Run Posted",
    "description": "BillRunPosted",
    "namespace": "user.notification"
  }
}

Payment Term Updated

You can use the following request sample to create a custom event of AccountPaymentTermUpdate.

{
  "active": true,
  "baseObject": "Account",
  "condition": "changeType == 'UPDATE' && Account.PaymentTerm_old != Account.PaymentTerm",
  "description": "Generate an event when a account PaymentTerm is updated",
  "eventType": {
    "description": "Generate an event when a account PaymentTerm is updated",
    "displayName": "Account Update",
    "name": "AccountPaymentTermUpdate"
  }
}

Custom object record created

You can use the following request sample to create a custom event that will be triggered when certain custom object records are created for the Vehicle custom object.

{
  "active": true,
  "baseObject": "default__vehicle",
  "condition": "changeType == 'INSERT' && default__vehicle.Price__c >= 5000.0",
  "description": "Generate an event when a vehicle record whose price is greater than 5000 is created",
  "eventType": {
    "name": "VehicleCreated",
    "displayName": "Vehicle Created",
    "description": "Generate an event when a vehicle record whose price is greater than 5000 is created"
  }
}

Custom object record updated

You can use the following request sample to create a custom event that will be triggered when certain custom object records are updated for the Entitlement custom object.

{
  "active": true,
  "baseObject": "default__entitlement",
  "condition": "changeType == 'UPDATE' && default__entitlement.Usage__c >= default__entitlement.Entitled__c && default__entitlement.Status != 'Trial'",
  "description": "Generate an event when an entitlement record is updated, if the usage equals to or greater than the entitlement and the entitlement status is not trial",
  "eventType": {
    "name": "EntitlementUpdated",
    "displayName": "Entitlement Updated",
    "description": "Generate an event when an entitlement record is updated, if the usage equals to or greater than the entitlement and the entitlement status is not trial"
  }
}