Skip to main content

Notifications

The AWS Simple Notification Service (Amazon SNS) is a managed service that provides message delivery from publishers to subscribers. Publishers communicate asynchronously with subscribers by sending messages to a topic, which is a logical access point and communication channel. Clients can subscribe to the SNS topic and receive published messages using Amazon SQS.

In the LIV Data Platform, there are currently 3 types of SNS notifications available:

  • Leaderboard
  • Team Leaderboard
  • Course Map

The LIV Data Platform utilises FIFO topics to ensure all messages are delivered in order.

In the sections below, there is a detailed breakdown of each message type with sample payloads and a list of the available items that you can expect to receive from each.

For further reading around AWS SNS please refer to the following AWS SNS documentation

SNS Message Attributes​

type​

Specifies the notification type (leaderboard, teamLeaderboard, courseMap)

tournamentId​

The related tournament id for the updated data.

fullDataRefresh​

Flags if the updated data is too large to be contained in a single event. If this is set to true, clients should pull the full data set from the relevant query endpoint.

SNS Message Types​

Leaderboard​

This notification is triggered when any change is made to a leaderboard.

The data delivered mirrors the leaderboardPlayerUpdated from the GraphQL Subscription type.

Team Leaderboard​

This notification is triggered when any change is made to a team leaderboard.

The data delivered mirrors the leaderboardTeamUpdated from the GraphQL Subscription type.

Course Map​

This notification is triggered when any change is made to a holeMap from the course map endpoint.

The data delivered mirrors the holeMapUpdated from the GraphQL Subscription type.