Pricing Templates
Log in Sign up
Integrations / Zuora / ...

POST /events/event-triggers

When you create an event trigger, you must specify the base object and define the trigger condition.

Specify the base object

Use baseObject field to specify which object to define a trigger on. You can define an event trigger on any of the following objects:

In addition to the above Zuora standard objects, you can also use custom objects as base objects for custom events.

Tenant level base objects and tenant level event triggers

Zuora identifies the following base objects and custom 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.

Define the trigger condition

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:

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

Limitations

This event trigger has the following limitations:

See Custom Events for more information.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Content-Encoding String No

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
Zuora-Track-Id String No

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 (:), semicolon (;), double quote ("), and quote (').
Authorization String Yes

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Idempotency-Key String No

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.
Zuora-Entity-Ids String No

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-Org-Ids String No

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.
Accept-Encoding String No

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Request body fields

Name Type Required Description
active Boolean Yes

The status of the event trigger.
description String No

The description of the event trigger.
eventType Object Yes
eventType.name String Yes

The name of the event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\w\-]*$
eventType.description String No

The description of the event type.
eventType.displayName String Yes

The display name for the event type.
baseObject String Yes

The base object that the trigger rule is defined upon. The format of the value in this field depends on the base object type:

  • Standard object: object name, which should follow the pattern ^[A-Z][\w-]*$. For example, Invoice.
  • Custom object: default__<custom_object_api_name>. For example, default__vehicle.
condition String Yes

The JEXL expression to be evaluated against object changes. See above for more information and an example.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy