When you create an event trigger, you must specify the base object and define the trigger condition.
Use baseObject field to specify which object to define a trigger on. You can define an event trigger on any of the following objects:
Zuora identifies the following base objects as the tenant level base objects:
Event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications.
Note: Tenant level event triggers and system notifications are only available in the default profile.
The condition field is a JEXL expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on.
Note: The condition cannot contain fields from data source objects that are joined to the object that the trigger is defined on.
For example, the following condition 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
Where:
changeType is a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values of changeType are INSERT, UPDATE, and DELETE.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.
This event trigger has the following limitations:
The INSERT change type is not supported on RatePlan base objects.
The INSERT change type is not supported on SubscriptionProductFeature base objects.
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.
See Custom Events for more information.
| Idempotency-Key | string <= 255 characters Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. |
| Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
| Content-Encoding | string Include the |
| Authorization required | string The value is in the |
| Zuora-Entity-Ids | string An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
| Zuora-Track-Id | string <= 64 characters A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
OK
Bad Request
Server Error
{- "active": true,
- "baseObject": "Invoice",
- "condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000",
- "description": "Trigger an event when an invoice is posted with amount over 1000",
- "eventType": {
- "description": "An invoice is posted with amount over 1000",
- "displayName": "Large Invoice Posted",
- "name": "LargeInvoicePosted"
}
}"{\n \"id\": \"ac1ee535e8524858a72edb464212729d\",\n \"baseObject\": \"Invoice\",\n \"condition\": \"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000\",\n \"description\": \"trigger an event when an invoice is posted with amount over 1000\",\n \"eventType\": {\n \"name\": \"LargeInvoicePosted\",\n \"displayName\": \"Large Invoice Posted\",\n \"description\": \"An invoice is posted with amount over 1000\"\n },\n \"active\": true\n}"