Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Custom Scheduled Events API

A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and the notification parameters, the notification will be triggered immediately.For more information about Custom Scheduled Events, see Custom Scheduled Events.

Zuora Custom Scheduled Events API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Scheduled Events. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Scheduled Events 5

A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and t…

POST
/events/scheduled-events
Create a scheduled event
POST_ScheduledEvent 8 params → 200400500
GET
/events/scheduled-events
List all scheduled events
GET_ScheduledEvents 12 params → 200400500
GET
/events/scheduled-events/{id}
Retrieve a scheduled event by ID
GET_ScheduledEventByID 7 params → 200404500
PUT
/events/scheduled-events/{id}
Update a scheduled event by ID
UPDATE_ScheduledEventByID 8 params → 200400500
DELETE
/events/scheduled-events/{id}
Delete a scheduled event by ID
DELETE_ScheduledEventByID 7 params → 204404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are GetScheduledEventResponse (11 properties), PostScheduledEventRequest (10 properties), PutScheduledEventRequest (7 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

PostScheduledEventRequest
object
namespace.name pair should be unique universally
10 properties 6 required
PutScheduledEventRequest
object
7 properties
ErrorResponse
object
1 property
GetScheduledEventResponse
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-custom-scheduled-events-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API