Custom Events

Specify the base object 

Use baseObject field to specify which base object to define a custom event trigger on. 

Custom event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications.

Note that tenant level event triggers and system notifications are only available in the default communication profile.

Define the trigger condition 

Zuora uses the Apache Commons Java Expression Language (JEXL) library syntax for defining triggers.  

The condition field starts with declaring changeType to trigger the custom event, followed by the additional conditions on the base object. The supported values of changeType are INSERT, UPDATE, and DELETE.

The expression can only contain fields from the object that the trigger is defined on. For example, Invoice.Amount > 1000.0. See Data Source Reference for more information about the fields on each object.

You can find all available JEXL syntax in Apache Commons JEXL. For your easy reference, the most commonly used operators and syntax examples are provided in the following table:

The following condition example causes an event to be triggered whenever an invoice is posted with an amount greater than 1000:

changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0

Where:

• changeType is a keyword that specifies the type of change that occurred to the Invoice object.

• Invoice.Status is the value of the Invoice object's Status field after the change occurred.

• Invoice.Status_old is the value of the Invoice object's Status field before the change occurred.

In the above example, the value of baseObject is Invoice.

Custom fields are also supported. Thus, you can define conditions on custom fields that you specifically created in your tenant.

Moreover, when you define conditions, you can also use JEXL built-in functions. For example, size().

In the following example, the JEXL built-in function size()  is used and one condition is defined on the custom field TradingPartnerCode__c.

(changeType == 'UPDATE' || changeType == ‘INSERT’) && size(Account.CrmId) != 18 && size(Account.TradingPartnerCode__c) > 0

Sample code for custom events

See the following request samples for the Create an event trigger operation to create custom events.

{
  "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"
  }
}

{
  "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"
  }
}

Limitations 

The custom events have the following limitations:

• The INSERT change type is not supported on RatePlan base object.

• The INSERT change type is not supported on SubscriptionProductFeature base object.

• When creating custom events, you cannot match fields of the RatePlanCharge object against constant values for the condition field. For example, the following condition will cause errors: RatePlanCharge.ShippingProcessStatus__c == 'Shipping Confirmed' , where Shipping Confirmed is a constant value.

• Fields on objects are case-sensitive. For example, PaymentMethod.createdbyid can result in errors. The correct format is PaymentMethod.CreatedById. 

• A condition cannot contain fields from data source objects that are joined to the base object.

• Do not create duplicate events because they will be either merged or deleted. Zuora considers events that have the same trigger condition as duplicate events, regardless of event type names. 

• For custom events triggered on the Amendment object, merge fields defined within the notification definition are only available for the amendment completed events.