Open APIs

Dear all,

I hope you're doing well. I'd like to share that we are currently implementing TMF681 Communication Management, and the CTK requires us to implement three resources: communicationMessage, hub, and listener.

Our current implementation involves the following components:

Consumer (Channel) --> API_TMF681 --> Microservice_TMF681 --> DB (Notifications)

Consumer (Channel): The system interested in sending notifications through TMF681.
API_TMF681: API exposed via API Management.
Microservice_TMF681: Microservice deployed in a container.
DB (Notifications): Database where notifications are managed.

We have some questions regarding the correct implementation of the hub and listener, and their respective responsibilities.

1. Hub

As we understand it, the hub is used to manage subscribers to certain events.

• POST /hub: Create/Register a subscriber
• DELETE /hub/{id}: Delete a subscriber
• Is the callback in the body intended to respond with success/error of the subscription, or to notify the subscribed information to that callback?
• What type of information is the subscriber subscribing to?
• Are subscribers only subscribing to TMF681 listener events?
• How can we differentiate which type of information a subscriber should have access to?
• Who should be allowed to perform POST /hub? Should it be another system managing events and subscriptions, or the same Notification system?
• Who should be considered the provider of these hubs? The Notification system?

2. Listener

As we understand it, the listener is responsible for handling events within TMF681.

• POST /listener/communicationMessageAttributeValueChangeEvent
• POST /listener/communicationMessageStateChangeEvent

• Who should be allowed to trigger these listener endpoints, and when?
• Should it be the Notification database via a trigger?
• Or should the microservice call the listener asynchronously after a PATCH /communicationMessage request?
• Who would be considered the provider of these listeners? The systems that subscribed via the hub?

3. Relationship with TMF688

How do points 1 and 2 relate to TMF688_Event_Management, which also handles hub and event resources (similar to the listener concept)?

Based on points 1, 2, and 3, what would be the correct design approach to clearly define the responsibilities and integration roles of the involved consumers and providers?

Thank you in advance for your guidance and support.

Best regards