Retrieve a scheduled event by ID

GET

/events/scheduled-events/:id

GET

/events/scheduled-events/:id

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.custom_scheduled_events.get_scheduled_event_by_id(
    id="id",
)

{
  "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": {
    "_SUBSCRIPTION_STATUS": {
      "description": "The status of the subscription",
      "displayName": "Subscription Status",
      "options": [
        "Draft",
        "Active",
        "Pending",
        "Expired",
        "Cancelled"
      ],
      "valueType": "STRING"
    }
  }
}

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

idstringRequired

The ID of the scheduled event.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

activebooleanOptional

Indicate whether the scheduled event is active or inactive

apiFieldstringOptional

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\-]*$

apiObjectstringOptional

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\-]*$

conditionstringOptional

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

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

cronExpressionstringOptional

The cron expression defines the time when scheduled event notifications will be sent.

descriptionstringOptional

The description of the scheduled event.

displayNamestringOptional

The display name of the scheduled event.

idstringOptionalformat: "uuid"

Scheduled event ID.

namestringOptional

The name of the scheduled event.

namespacestringOptional

The namespace of the scheduled event name in the name field.

parametersmap from strings to objectsOptional

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.

Errors

404

Not Found Error

500

Internal Server Error