Subscribe to and manage real-time event streams from Avaya Infinity. Register webhook endpoints to receive live notifications for agent activity (login, logout, ready/not-ready state changes) and interaction lifecycle events (created, completed, transferred). Subscriptions are time-limited and must be renewed before expiry to remain active.
Endpoints
Create Subscription
POST /subscriptions
Creates a new webhook subscription for one or more event families.
List Subscriptions
GET /subscriptions
Returns a paginated list of existing subscriptions.
Get Subscription
GET /subscriptions/{subscriptionId}
Returns a single subscription by its ID.
Update Subscription
PATCH /subscriptions/{subscriptionId}
Partially updates a subscription's event families, events, or transport configuration.
Renew Subscription
POST /subscriptions/{subscriptionId}:renew
Renews an active or inactive subscription before or after expiry, optionally updating the webhook auth token.
Delete Subscription
DELETE /subscriptions/{subscriptionId}
Permanently deletes a subscription by its ID.
Getting Started
Find Your Customer Subdomain
Your subdomain is found in your Infinity portal URL and is required for all API calls.
Example: If your portal URL is:
https://core.avaya1234.ec.avayacloud.com/app/core-config-ui/Your subdomain is: avaya1234
All API requests use this format:
https://core.{customerId}.ec.avayacloud.com/api/events/v1/...Authentication
All endpoints require Bearer token authentication. To get started, contact Avaya Support to request a client_id and client_secret provisioned with the EVENT_NOTIFICATION scope. Once you have your credentials, generate an access token.
Working with Subscriptions
Subscriptions follow a simple lifecycle:
- Create — register your webhook endpoint and select the event families and events to receive
- Active — your webhook receives events in real time while the subscription is active
- Renew — call the Renew endpoint before
expiresInreaches zero to keep the subscription active - Inactive — if not renewed in time, the subscription becomes
INACTIVEand stops delivering events; it can be reactivated via the Renew endpoint
The expiresIn field in every response shows the seconds remaining before the subscription expires.
Common Integration Patterns
Agent Activity Monitoring — Subscribe to the AGENT family to track login, logout, ready, and not-ready state changes in real time for workforce management or reporting dashboards.
Interaction Lifecycle Tracking — Subscribe to the INTERACTION family to trigger downstream workflows when interactions are created, completed, or transferred.
Webhook Token Rotation — Use the Renew endpoint to update your authToken at the same time as renewing the subscription, keeping your webhook verification token fresh without recreating the subscription.