List event triggers

Request

query Parameters

baseObject	string The Zuora object that trigger condition 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`.
eventTypeName	string The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\w-]*$
active	string The status of the event trigger.
start	integer >= 0 Default: 0 The first index of the query result. Default to 0 if absent, and the minimum is 0.
limit	integer >= 1 Default: 10 The maximum number of data records to be returned. Default to 10 if absent.

header Parameters

Authorization required	string The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Accept-Encoding	string 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.
Content-Encoding	string 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-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-Org-Ids	string 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.
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 (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).

Responses

200

400

Bad Request

500

Server Error

get/events/event-triggers

Request samples

cURL

Response samples

application/json

"{\n  \"data\": [\n    {\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    }\n  ],\n  \"next\": \"https://api.zuora.com/events/event-triggers?start=1&limit=1\"\n}"