Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEventSubscriptionRequest

A request that the integration will send to Ultra that will allow the integration to be notified when one of the subscribed events has been triggered.

The requesting integration must have the following authorization scopes to subscribe to certain events:

Note: an integration with an authorization scope of * will be able to subscribe to all events.

An example request to subscribe to click, hover, and route events:

example

 {
   type: 'event:subscribe',
   subscriptions: ['click', 'hover', 'route']
 }

Hierarchy

  • IEventSubscriptionRequest

Index

Properties

Properties

subscriptions

An array of UltraIntegrationSubscriptionType events.

type

type: "event:subscribe"

Must be SUBSCRIBE_TYPE.

Generated using TypeDoc