How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Notifications API

Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically refer to HTTP invocations, such as HTTP calls to REST services.**NOTE:** Notifications are processed asynchronously and may be delivered with a delay and out of order.Notifications are associated with Communication Profiles, which allow you to send specific event-driven notifications to targeted customers. Zuora provides the following Settings API to access the settings of Communication Profiles: * [Get all Communication Profiles](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Communication_Profiles) * [Create a new Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Create_a_new_Communication_Profile) * [Modify a Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Modify_a_Communication_Profile) * [Get all Notifications under a particular Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Notifications_under_a_particular_Communication_Profile)

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

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 11 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 2023-12-15.

Requests are made against a single base URL, https://rest.zuora.com/.

17 operations 11 paths 24 schemas 3 DELETE7 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-12-15
Server
https://rest.zuora.com/
Resource Areas
1

Paths & Operations 17

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

Notifications 17

Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically ref…

POST
/notifications/notification-definitions
Create a notification definition
POST_Create_Notification_Definition 7 params body → 200400404405415500
GET
/notifications/notification-definitions
List notification definitions
GET_Query_Notification_Definitions 11 params → 200404405415500
PUT
/notifications/notification-definitions/{id}
Update a notification definition
PUT_Update_Notification_Definition 7 params body → 200400404405415500
GET
/notifications/notification-definitions/{id}
Retrieve a notification definition
GET_Get_Notification_Definition 7 params → 200404405415500
DELETE
/notifications/notification-definitions/{id}
Delete a notification definition
DELETE_Delete_Notification_Definition 7 params → 204400404405415500
POST
/notifications/email-templates
Create an email template
POST_Create_Email_Template 7 params body → 200400404405415500
GET
/notifications/email-templates
List email templates
GET_Query_Email_Templates 11 params → 200404405415500
POST
/notifications/email-templates/import
Create or update email templates
POST_CreateOrUpdateEmailTemplates 7 params body → 200
PUT
/notifications/email-templates/{id}
Update an email template
PUT_Update_Email_Template 7 params body → 200400404405415500
GET
/notifications/email-templates/{id}
Retrieve an email template
GET_Get_Email_Template 7 params → 200400404405415500
DELETE
/notifications/email-templates/{id}
Delete an email template
DELETE_Delete_Email_Template 7 params → 204400404405415500
DELETE
/notifications/history
Delete notification histories for an account
DELETE_Delete_Notification_History_For_Account 7 params → 202400404
GET
/notifications/history/tasks/{id}
Retrieve a notification history deletion task
GET_Get_Notification_History_Deletion_Task 7 params → 200404
POST
/notifications/email-histories/resend
Resend email notifications
POST_ResendEmailNotifications 7 params body → 202400
POST
/notifications/callout-histories/resend
Resend callout notifications
POST_ResendCalloutNotifications 7 params body → 202400
GET
/v1/notification-history/callout
List callout notification histories
GET_CalloutHistory 14 params → 200
GET
/v1/notification-history/email
List email notification histories
GET_EmailHistory 14 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are GETPublicEmailTemplateResponse (25 properties), POSTCreateOrUpdateEmailTemplateRequestFormat (21 properties), POSTPublicEmailTemplateRequest (20 properties), GETPublicNotificationDefinitionResponse (18 properties). Each schema is shown below with its type and property counts.

POSTPublicEmailTemplateRequest
object
20 properties 5 required
FilterRuleParameterDefinitions
object
The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of…
GETPublicEmailTemplateResponse
object
25 properties
NotificationsHistoryDeletionTaskResponse
object
The notification history deletion task information.
6 properties
FilterRuleParameterValues
object
The parameter values used to configure the filter rule.
GETCalloutHistoryVOsType
object
3 properties
POSTResendCalloutNotifications
array
GETPublicNotificationDefinitionResponse
object
18 properties
CalloutAuth
object
If requiredAuth is true, this object is required.
4 properties
POSTCreateOrUpdateEmailTemplateRequestFormat
object
21 properties 5 required
PUTPublicNotificationDefinitionRequest
object
11 properties
POSTResendEmailNotifications
array
POSTPublicNotificationDefinitionRequest
object
13 properties 2 required
ResendCalloutNotificationsFailedResponse
object
GETCalloutHistoryVOType
object
9 properties
GETEmailHistoryVOsType
object
3 properties
CreateOrUpdateEmailTemplatesResponse
object
1 property
GETEmailHistoryVOType
object
12 properties
PUTPublicEmailTemplateRequest
object
17 properties
POSTCreateOrUpdateEmailTemplateRequest
object
2 properties
ErrorResponse
object
1 property
FilterRuleParameterDefinition
object
Definition of a filter rule parameter.
4 properties
CalloutMergeFields
object
A key-value map of merge fields of this callout.
ResendEmailNotificationsFailedResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-notifications-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
Where this information came from

This is an independent, third-party profile of Zuora Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.