Skip to content

OSDU Notification Service

Introduction

The OSDU notification system allows for interested consumers to subscribe to data and metadata changes using a publish/subscriber pattern.

A typical workflow using notification is:

  • Consumer finds a "topic" that they want to keep up to date with any changes in OSDU.
  • Consumer creates Push endpoint, that is used to receive notifications on the interested topic.
  • Consumer creates a Subscription in OSDU Notification System, and proves the ownership of the Push endpoint.
  • Consumer starts to receive notifications for that topic and processes the message to synchronize with the OSDU state.
  • Consumer periodically rotates the "secret" used for subscription.

The topics below describe these steps/APIs in detail that allow consumers to create such integrated workflows using OSDU Notification.