Happy Business Starts Here

Highlighted
Zuora Support Moderator

Notification and Event API Changelog

This changelog outlines the latest REST API updates and documentation updates in the Notification and Event API. The Notification and Event API is in Limited Availability.

 

2018-02-07

 

API Updates

  • Notification Definition - Made the following updates:
    • Changed the endpoint /notification/notification-definitions to /notifications/notification-definitions.
    • In the request body of the “Create a notification definition” and “Update a notification definition” operations, and in the 200 response schema of the “Query notification definitions” and “Get a notification definition” operations:
      • Changed the calloutTemplateId field to the callout field.
      • Changed the filterRuleTemplateId field to the filterRule field.
  • Event Triggers - Changed the endpoint /ocp/event-triggers to /events/event-triggers.
  • Removed the “Callout Template” and “Filter Rule Template” sections.
  • Removed the "Create callout options" operation to avoid confusion.

2017-12-06

 

Doc Updates

  • Changed the name of the API from "Notification and Event Services API" to "Notification and Event API".
  • Added a CURL example for the “Update an event trigger” operation.

 

2017-11-08

 

API Updates

  • Renamed the following fields:
    • In the Event Triggers operations, changed apiObject to baseObject.
    • In the Filter Rule Template operations, changed expression to condition.
Tags (1)
5 REPLIES
Zuora Documentation

Re: Notification and Event API Changelog

2018-03-21

 

The Notification and Event API is now in GA and it is now moved to the main API Reference. We will stop maintaining the Notification and Event API Reference from now on. All changes to the Notification and Event API will be recorded in the main API Changelog.

Valued Scholar

Re: Notification and Event API Changelog

Hello!  is this feature only supported via API, or are there plans to have this available via UI?

Zuora Documentation

Re: Notification and Event API Changelog

At this stage, UI is not at parity with API. Some features are only accessible via API. Here are the details:

  • Event Triggers: only supported via API.
  • Email Templates: supported via both API and UI.
  • Notification Definitions: supported via both API and UI, with the following exceptions:
    • Filter Rules can only be added when creating a Notification Definition via API.
  • Callout Options: supported via both API and UI.

Based off the PM's reply, closing the gap between API and UI is on our roadmap, but it is not the super high priority thing and it will take some time to perfect our UI. We cannot promise the time at this point. Please stay tuned. Thanks!

Valued Scholar

Re: Notification and Event API Changelog

I don't see anything different in my list of Callout options in UI (I would expect to see callout options for the newly supported objects, right?) - does this feature need to be enabled on our tenant or is GA for everyone?

Zuora Documentation

Re: Notification and Event API Changelog

You should be able to see the following page when clicking your username on the top right corner and navigate to Billing Settings, Payment Settings, or Finance Settings > Setup Profiles, Notifications and Email Templates > Callout Options.

callout options.png

This feature is in GA, which means your tenant should be can access this feature without making any extra effort. Thanks!