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

TM Forum events subscription API

Endpoints to register and terminate an Event Listener

TM Forum events subscription API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include events subscription. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 11 base URLs: https://serverRoot/productCatalogManagement/v5/, {apiRoot}/tmf-api/troubleTicket/v5/, https://serverRoot, {apiRoot}/tmf-api/customer/v5/, https://serverRoot/partyManagement/v5/, https://serverRoot/tmf-api/serviceCatalogManagement/v4/, https://serverRoot/tmf-api/resourceCatalog/v4/, https://serverRoot/tmf-api/serviceOrdering/v4, https://serverRoot/tmf-api/quoteManagement/v4/, https://serverRoot/tmf-api/agreementManagement/v4/, https://serverRoot/tmf-api/accountManagement/v4/.

3 operations 2 paths 16 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://serverRoot/productCatalogManagement/v5/
{apiRoot}/tmf-api/troubleTicket/v5/
https://serverRoot
{apiRoot}/tmf-api/customer/v5/
https://serverRoot/partyManagement/v5/
https://serverRoot/tmf-api/serviceCatalogManagement/v4/
https://serverRoot/tmf-api/resourceCatalog/v4/
https://serverRoot/tmf-api/serviceOrdering/v4
https://serverRoot/tmf-api/quoteManagement/v4/
https://serverRoot/tmf-api/agreementManagement/v4/
https://serverRoot/tmf-api/accountManagement/v4/
Resource Areas
1

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

events subscription 3

Endpoints to register and terminate an Event Listener

POST
/hub
TM Forum Create a Subscription (hub) to Receive Events
createHub body → 201default
DELETE
/hub/{id}
TM Forum Remove a Subscription (hub) to Receive Events
hubDelete 1 param → 204default
GET
/hub/{id}
TM Forum Retrieve a Subscription (hub)
hubGet 1 param → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Error_2 (8 properties), Error_7 (8 properties), Error_6 (8 properties), Error_5 (8 properties). Each schema is shown below with its type and property counts.

Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Hub
object
Sets the communication endpoint address the service instance must use to deliver notification information
Addressable
object
Base schema for adressable entities
2 properties
Hub_FVO
object
Sets the communication endpoint address the service instance must use to deliver notification information
1 required
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
Addressable_2
object
Base schema for addressable entities
2 properties
Addressable_3
object
Base schema for addressable entities
2 properties
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties 1 required
Error_2
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties 2 required
Error_3
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
Error_4
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
Error_5
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
Error_6
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
Error_7
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

tm-forum-events-subscription-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum exportJob API
TM Forum financialAccount API
Where this information came from

This is an independent, third-party profile of TM Forum events subscription API, 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.