Canvas Guides (en)Canvas GuidesCanvas Admin Guide Canvas Data ServicesHow do I subscribe to Live Events using Canvas Data Services?

How do I subscribe to Live Events using Canvas Data Services?

As an admin, you can subscribe to Live Events and receive a real-time set of events from your Canvas Account. You can choose which events in Canvas you want to subscribe to. You will need to maintain an Amazon Web Services queue to receive Live Events data.

Additionally, Canvas has custom extensions available for many objects and types.

Notes:

  • If you do not have access to the Canvas Data Portal in your account, please contact your Customer Success Manager.
  • To receive Live Events data, you will need to subscribe to Amazon Web Services in order to maintain a queue.

Open Account

Open Account

Click the Admin link [1], then click the name of the account [2].

Open Data Services

Open Data Services

In Account Navigation, click the Data Services link.

Add Data Stream

Add Data Stream

To create a new data stream for your account, click the Add Stream button.

Configure Data Stream

Configure Data Stream

Enter a title for your stream in the Name/Title field [1].

Select an SQS or HTTPS delivery method in the Delivery Method drop-down menu [2]. Then enter your AWS SQS or an HTTPS endpoint URL in the URL field [3].

Notes:

  • Only one delivery method is allowed per subscription.
  • Canvas uses JWT to sign an event. If service is unavailable and Canvas cannot reach it, the events will not be delivered for the duration of the service outage.

Configure Amazon SQS Data Stream

Configure Amazon SQS Data Stream

If you want to require authentication for an Amazon SQS URL, select the AWS Credentials in the Authentication field [1]. If authentication is not required, this field can be set to the None option.

If AWS credentials are required, enter the AWS key [2], AWS secret [3], and AWS region [4].

Select the event format in the Message Type field [5]. Message type can be set to Canvas or Caliper 1.1.

Note: The Application Type field can only be set to the Data Streaming option.

 

Configure HTTPS Data Stream

The HTTPS delivery method includes an option to display source endpoint payload data with your data stream. To view payload data, select the Sign Payload checkbox [1].

Select the event format in the Message Type field [2]. Message type can be set to Canvas or Caliper 1.1.

Note: The Application Type field can only be set to the Data Streaming option.

Select Subcriptions

Select Subscriptions

Select the subscriptions you want to include in your data stream.

To search for specific events, type the event name in the Search Events field [1].

To include all events in your stream, click the Subscriptions checkbox [2]. Selecting this option includes all event types as well as user and system generated actions.

To subscribe to events triggered by an action directly performed by and end user, click the User Generated checkbox [3]. User generated events include information about web requests, browser and user data in event metadata, and details about objects affected by the change.

To subscribe to events triggered by asynchronous jobs, click the System Generated checkbox [4]. System generated events include data about processes that triggered an event as well as details about objects affected by the change.

You can also subscribe to event groups. To subscribe to all items in a group, click the checkbox for the group [5]. You can also select to include only User or System Generated data [6].

To subscribe to individual events, click the Arrow icon for the subscription group [7] and click the checkbox for the subscription you want to add [8].

Note: The image in this step shows subscription options for the Canvas message type. The options for the Caliper 1.1 message types are different, but the steps to subscribe are the same.

Save Data Stream

Save Data Stream

To save your data stream, click the Save & Exit button.

View Data Streams

View Data Streams

You can view and manage your data streams on the Data Streaming Options page.