Create a scheduled event

To create a custom scheduled event, you must specify the base object, the base field and the scheduled time.

Request
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.

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

Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

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

displayName
required
string [ 1 .. 500 ] characters

The display name of the scheduled event.

apiObject
required
string

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.

apiField
required
string

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.

hours
required
integer [ 0 .. 23 ]

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

minutes
required
integer [ 0 .. 59 ]

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

active
boolean
Default: true

Indicate whether the scheduled event is active or inactive.

condition
string <= 65535 characters

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.

description
string <= 1000 characters

The description of the scheduled event.

object

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.

Responses
200

OK

400

Bad Request

500

Server Error

post/events/scheduled-events
Request samples
application/json
{
  • "active": true,
  • "apiField": "TermEndDate",
  • "apiObject": "Subscription",
  • "condition": "Subscription.Status == _SUBSCRIPTION_STATUS",
  • "description": "Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.",
  • "displayName": "Term End Date Scheduled Event",
  • "hours": 10,
  • "minutes": 30,
  • "name": "TermEndDateScheduledEvent",
  • "parameters": {
    }
}
Response samples
application/json
{
  • "active": true,
  • "apiField": "TermEndDate",
  • "apiObject": "Subscription",
  • "condition": "Subscription.Status == _SUBSCRIPTION_STATUS",
  • "cronExpression": "0 30 10 ? * *",
  • "description": "Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.",
  • "displayName": "Term End Date Scheduled Event",
  • "id": "d306545b74e445e4bffcf1c7609804be",
  • "name": "TermEndDateScheduledEvent",
  • "namespace": "user.notification",
  • "parameters": {
    }
}