Introduction to the Event Hub Service
Getting started with the Event Hub Service.
Welcome to the CoreMedia Event Hub Service documentation. In this introduction, you will get a basic overview of the Event Hub and how to use it.
Overview of the Architecture
The CoreMedia Event Hub Service is a cloud-only service, which enables you to subscribe to the events of CoreMedia Content Cloud. An event is created whenever a content item has been changed, created, or deleted on either the Content Management Server or the Master Live Server. Additionally, certain user actions in CoreMedia Studio and changes in workflows can trigger events.
Events happening on a CoreMedia Content Cloud instance are sent to the Event Hub Service. The service receives the events, processes, and distributes them to the registered webhooks.
Events
You can use the Event Hub Service to consume three kinds of events:
-
Content Events
Events from the content repository, analogous to the content events in the CoreMedia Unified API. Examples are:
-
content creation
-
content update
-
check-in/out
-
approval
-
publication/depublication
-
deletion
-
-
Workflow Events (Coming soon)
Workflow relevant events like
-
Workflow subscriptions
-
Workflow status changes
-
-
Notification Events (Coming soon)
All events that are also available as Studio notifications are available as editorial events in the Event Hub. This includes:
-
Editorial Comments in Studio
-
Other notifications like project assignments.
-
Webhooks
Webhooks are simple URL endpoints. The Event Hub Service sends the event payload in JSON format in the request body to registered webhook endpoints.
The webhook endpoint must respond with one of the following status codes:
-
OK (200)
-
ACCEPTED (202)
-
NO_CONTENT (204)
The endpoint should respond as fast as possible to avoid timeouts on the sender side which would lead to repeated retransmissions of the same message. It’s recommended to handle the incoming messages asynchronously. That is, persisting them to a durable storage and returning the webhook call and using asynchronous workers to do the real processing on the persisted messages.
Webhook JSON API
Find the Event Hub Webhook JSON API at https://documentation.coremedia.com/eventhub-api/
Configuration of the Webhook Subscription
You can configure the request with the event payload to the webhook endpoint:
-
The request method must be POST or PUT.
-
A list of header parameters.
-
Currently, only basic authentication is supported. Contact CoreMedia for other authentication schemes.
Webhook Subscription Self Service
You can administer webhook endpoints by yourself using the event subscription service. Find the event subscription API at https://documentation.coremedia.com/eventdeliveryconfig-api/
The URL of subscription service may vary from instance to instance and the service is protected by access tokens. As explained below, the CoreMedia support will provide you with the URL and with instructions on how to access the subscription service.
Activation of the Event Hub Service
Contact the CoreMedia support at support@coremediaoncloud.com to get the Event Hub Service activated for your account.
The CoreMedia support will provide you with the URL of the subscription service and will provide secrets in the Cloud Manager of your instance. Use the secrets to get the token, necessary to access the subscription service.