POST /events/scheduled-events

Default value: "application/json"

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.

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 (').

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

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.

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.

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.

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.

The base field of the base object in the apiObject field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\w\-]*$

See Custom Scheduled Events for all available base fields.

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

Indicate whether the scheduled event is active or inactive.

Default value: true

The description of the scheduled event.

The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications.

Definition of a filter rule parameter.

The description of the parameter.

The option values of the parameter.

The display name of the parameter.

The type of the value.

Possible values:

• "CHARACTER_ARRAY"
• "STRING"
• "BOOLEAN_ARRAY"
• "LOCAL_DATE_TIME"
• "INTEGER"
• "LOCAL_DATE"
• "TIMESTAMP_ARRAY"
• "FLOAT"
• "LOCAL_DATE_ARRAY"
• "LONG"
• "CHARACTER"
• "INTEGER_ARRAY"
• "FLOAT_ARRAY"
• "SHORT_ARRAY"
• "DOUBLE"
• "BYTE"
• "BIG_INTEGER"
• "TIMESTAMP"
• "STRING_ARRAY"
• "BIG_DECIMAL_ARRAY"
• "DOUBLE_ARRAY"
• "BOOLEAN"
• "LOCAL_DATE_TIME_ARRAY"
• "BIG_INTEGER_ARRAY"
• "SHORT"
• "BIG_DECIMAL"
• "BYTE_ARRAY"

The filter rule conditions, written in JEXL. The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from the base object of the event or from the joined objects of the base object. Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:

Invoice.Amount > 1000

Invoice.Amount refers to the Amount field of the Zuora object Invoice.

The display name of the scheduled event.

The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.

The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\w\-]*$

See Custom Scheduled Events for all available base objects.

The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.