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 Notifications. 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 2.0, at version 2023-12-15.
Metadata
The identity and technical contract details declared by the specification.
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 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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zuora 12
Other APIs Zuora publishes across the network.