How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MTN TMF688 - Event Management

The Event Management API provides a standardized client interface to the enterprise event management system.

MTN TMF688 - Event Management is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include TM Forum, TMF688, and South Africa. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 16 operations across 11 paths, organized into 5 resource areas, and defines 31 schemas. It is described by OpenAPI 2.0, at version 4.0.0.

Requests are made against the base URL https://api.mtn.com/tmf-api/event/v4.

16 operations 11 paths 31 schemas 3 DELETE6 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
4.0.0
Base URL
https://api.mtn.com/tmf-api/event/v4
Authentication
basic, API Key
Resource Areas
5

Authentication & Security 2

MTN TMF688 - Event Management declares 2 security schemes for authenticating requests. It defines a basic scheme (basicAuth). An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 3 DELETE, 6 GET, 7 POST. They span 5 resource areas: event, topic, hub, events subscription, notification listeners (client side). Each is listed below with its method, path, parameters, and response codes.

event 3
GET
/topic/{topicId}/event
List or find Event objects
listEvent 4 params → 200400401403404405409500
POST
/topic/{topicId}/event
Creates a Event
createEvent 2 params → 201400401403405409500
GET
/topic/{topicId}/event/{id}
Retrieves a Event by ID
retrieveEvent 3 params → 200400401403404405409500
topic 4
GET
/topic
List or find Topic objects
listTopic 3 params → 200400401403404405409500
POST
/topic
Creates a Topic
createTopic 1 param → 201400401403405409500
GET
/topic/{id}
Retrieves a Topic by ID
retrieveTopic 2 params → 200400401403404405409500
DELETE
/topic/{id}
Deletes a Topic
deleteTopic 1 param → 204400401403404405409500
hub 4
GET
/topic/{topicId}/hub
List or find Hub objects
listHub 4 params → 200400401403404405409500
POST
/topic/{topicId}/hub
Creates a Hub
createHub 2 params → 201400401403405409500
GET
/topic/{topicId}/hub/{id}
Retrieves a Hub by ID
retrieveHub 3 params → 200400401403404405409500
DELETE
/topic/{topicId}/hub/{id}
Deletes a Hub
deleteHub 2 params → 204400401403404405409500
events subscription 2
POST
/hub
Register a listener
registerListener 1 param → 201400401403404405409500
DELETE
/hub/{id}
Unregister a listener
unregisterListener 1 param → 204400401403404405500
notification listeners (client side) 3
POST
/listener/topicCreateEvent
Client listener for entity TopicCreateEvent
listenToTopicCreateEvent 1 param → 201400401403404405409500
POST
/listener/topicChangeEvent
Client listener for entity TopicChangeEvent
listenToTopicChangeEvent 2 params → 201400401403404405409500
POST
/listener/topicDeleteEvent
Client listener for entity TopicDeleteEvent
listenToTopicDeleteEvent 1 param → 201400401403404405409500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Event (17 properties), Event_Create (17 properties), TopicChangeEvent (14 properties), TopicCreateEvent (12 properties). Each schema is shown below with its type and property counts.

Any
BillStructure
object
The bill structure that associated to the customer.
2 properties
CycleSpecification
object
The customer bill cycle.
8 properties
CreditProfile
object
Credit profile for the party.
10 properties 2 required
Format
object
The bill invoice format.
3 properties
PresentationMedia
object
The bill invoice presentation media.
1 property
Characteristic
array
Describes a given characteristic of an object or entity through a name/value pair.
ContactMedium
array
Indicates the contact medium that could be used to contact the party.
CustomerOrder
object
details of product order
12 properties
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties 1 required
Event
object
event with common attributes.
17 properties
Event_Create
object
event with common attributes. Skipped properties: id,href
17 properties
Hub
object
A Hub is used to subscribe to an event notification
6 properties 2 required
Hub_Create
object
A Hub is used to subscribe to an event notification Skipped properties: id,href
5 properties 1 required
IndividualIdentification
object
Represents our registration of information used as proof of identity by an individual (national identity card)
2 properties
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party
12 properties
PartyRef
array
Party reference. A party represents an organization or an individual.
ProductOrder
object
details of product order
10 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
Topic
object
Is a event channel provided by the Event Streaming API
8 properties
Topic_Create
object
Is a event channel provided by the Event Streaming API Skipped properties: id,href
6 properties
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
5 properties 2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties 1 required
TopicCreateEvent
object
The notification data structure
12 properties
TopicCreateEventPayload
object
The event data structure
1 property
TopicChangeEvent
object
The notification data structure
14 properties
TopicChangeEventPayload
object
The event data structure
3 properties
TopicDeleteEvent
object
The notification data structure
12 properties
TimePeriod
object
A base / value business entity used to represent a period of time between two timepoints.
2 properties
TopicDeleteEventPayload
object
The event data structure
1 property
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-tmf688-event-management.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
MTN TMF Customer Bill Management - TMF678
MTN Loans
MTN Subscriber Details
MTN Subscriber Type
MTN Provisioning
MTN Unified Balance V1
MTN TMF Resource Inventory Management - TMF639
MTN Sales Lead
MTN Service Activation and Configuration
MTN Service Ordering
MTN BSS TT OAuth V1
Where this information came from

This is an independent, third-party profile of MTN TMF688 - Event Management, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.