Event Notifications Resources and Data Models - v3.1.2

Resources for Event Notifications are detailed here:

Endpoints

The API endpoints for these resources, and their mandatory/conditional/optional status are given below.

ResourceEndpointsMandatory?
event-subscriptionPOST /event-subscriptionsOptional
event-subscriptionGET /event-subscriptionsMandatory (if resource POST implemented)
event-subscriptionPUT /event-subscriptions/{EventSubscriptionId}Mandatory (if resource POST implemented)
event-subscriptionDELETE /event-subscriptions/{EventSubscriptionId}Mandatory (if resource POST implemented)
callback-urlPOST /callback-urlsOptional
callback-urlGET /callback-urlsMandatory (if resource POST implemented)
callback-urlPUT /callback-urls/{CallbackUrlId}Mandatory (if resource POST implemented)
callback-urlDELETE /callback-urls/{CallbackUrlId}Mandatory (if resource POST implemented)
event-notificationPOST /event-notificationsOptional
eventsPOST /eventsOptional

Notes

Definitions for Mandatory, Conditional and Optional are given in the Read/Write Data API Profile.

Event Notification Resource Compatibility

  Read-Write API ProfileRead-Write API ProfileRead-Write API ProfileEvent Notification API ProfileEvent Notification API ProfileEvent Notification API ProfileReal Time Event Notification API ProfileReal Time Event Notification API ProfileReal Time Event Notification API ProfileAggregated Polling API ProfileAggregated Polling API ProfileAggregated Polling API ProfileEvent Notification Subscription API ProfileEvent Notification Subscription API ProfileEvent Notification Subscription API ProfileCallback URL API ProfileCallback URL API ProfileCallback URL API Profile
  v3.1v3.1.13.1.2v3.1v3.1.13.1.2v3.1v3.1.13.1.2v3.1v3.1.13.1.2v3.1v3.1.13.1.2v3.1v3.1.13.1.2
Event Subscriptionv3.1TRUETRUETRUETRUETRUETRUEn/a  n/a  TRUETRUETRUEn/a  
 v3.1.1TRUETRUETRUETRUETRUETRUE      TRUETRUETRUE   
 v3.1.2TRUETRUETRUETRUETRUETRUE      TRUETRUETRUE   
Callback URLv3.1TRUETRUETRUETRUETRUETRUEn/a  n/a  n/a  TRUETRUETRUE
 v3.1.1TRUETRUETRUETRUETRUETRUE         TRUETRUETRUE
 v3.1.2TRUETRUETRUETRUETRUETRUE         TRUETRUETRUE
Event Notificationsv3.1TRUETRUETRUETRUETRUETRUETRUETRUETRUEn/a  n/a  n/a  
 v3.1.1TRUETRUETRUETRUETRUETRUETRUETRUETRUE         
 v3.1.2TRUETRUETRUETRUETRUETRUETRUETRUETRUE         
Eventsv3.1TRUETRUETRUETRUETRUETRUEn/a  TRUETRUETRUEn/a  n/a  
 v3.1.1TRUETRUETRUETRUETRUETRUE   TRUETRUETRUE      
 v3.1.2TRUETRUETRUETRUETRUETRUE   TRUETRUETRUE      

Table of contents