Event Notifications Resources and Data Models - v3.1.9

Resources for Event Notifications are detailed here:

• Event Subscriptions:
  • Event Subscription
  • Callback URL
• Real Time Event Notification:
  • Event Notifications
• Aggregated Polling:
  • Events

Endpoints

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

Resource	Endpoints	Mandatory?
event-subscription	POST /event-subscriptions	Optional
event-subscription	GET /event-subscriptions	Mandatory (if resource POST implemented)
event-subscription	PUT /event-subscriptions/{EventSubscriptionId}	Mandatory (if resource POST implemented)
event-subscription	DELETE /event-subscriptions/{EventSubscriptionId}	Mandatory (if resource POST implemented)
callback-url	POST /callback-urls	Optional
callback-url	GET /callback-urls	Mandatory (if resource POST implemented)
callback-url	PUT /callback-urls/{CallbackUrlId}	Mandatory (if resource POST implemented)
callback-url	DELETE /callback-urls/{CallbackUrlId}	Mandatory (if resource POST implemented)
event-notification	POST /event-notifications	Optional
events	POST /events	Optional

Notes

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

Event Notification Resource Compatibility

		Read-Write API Profile	Read-Write API Profile	Read-Write API Profile	Event Notification API Profile	Event Notification API Profile	Event Notification API Profile	Real Time Event Notification API Profile	Real Time Event Notification API Profile	Real Time Event Notification API Profile	Aggregated Polling API Profile	Aggregated Polling API Profile	Aggregated Polling API Profile	Event Notification Subscription API Profile	Event Notification Subscription API Profile	Event Notification Subscription API Profile	Callback URL API Profile	Callback URL API Profile	Callback URL API Profile
		v3.1	v3.1.1	3.1.2	v3.1	v3.1.1	3.1.2	v3.1	v3.1.1	3.1.2	v3.1	v3.1.1	3.1.2	v3.1	v3.1.1	3.1.2	v3.1	v3.1.1	3.1.2
Event Subscription	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	n/a			n/a			TRUE	TRUE	TRUE	n/a
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE							TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE							TRUE	TRUE	TRUE
Callback URL	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	n/a			n/a			n/a			TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE										TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE										TRUE	TRUE	TRUE
Event Notifications	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	n/a			n/a			n/a
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Events	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE	n/a			TRUE	TRUE	TRUE	n/a			n/a
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE				TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE				TRUE	TRUE	TRUE