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

GSMA Open Gateway notification listener API

Notifications for Resource Lifecycle and event notifications

GSMA Open Gateway notification listener API is one of 34 APIs that GSMA Open Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include notification listener. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths, and defines 73 schemas. It is described by OpenAPI 3.2.0, at version 5.2.1.

Requests are made against a single base URL, {apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/.

10 operations 10 paths 73 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.2.1
Server
{apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/
Resource Areas
1

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 10 POST. Each is listed below with its method, path, parameters, and response codes.

notification listener 10

Notifications for Resource Lifecycle and event notifications

POST
/listener/apiProductOrderAttributeValueChangeEvent
Client listener for entity ApiProductOrderAttributeValueChangeEvent
apiProductOrderAttributeValueChangeEvent body → 204default
POST
/listener/apiProductOrderCreateEvent
Client listener for entity ApiProductOrderCreateEvent
apiProductOrderCreateEvent body → 204default
POST
/listener/apiProductOrderStateChangeEvent
Client listener for entity ApiProductOrderStateChangeEvent
apiProductOrderStateChangeEvent body → 204default
POST
/listener/applicationApprovalStatusChangeEvent
Client listener for entity ApplicationApprovalStatusChangeEvent
applicationApprovalStatusChangeEvent body → 204default
POST
/listener/applicationAttributeValueChangeEvent
Client listener for entity ApplicationAttributeValueChangeEvent
applicationAttributeValueChangeEvent body → 204default
POST
/listener/applicationCreateEvent
Client listener for entity ApplicationCreateEvent
applicationCreateEvent body → 204default
POST
/listener/applicationOwnerApprovalStatusChangeEvent
Client listener for entity ApplicationOwnerApprovalStatusChangeEvent
applicationOwnerApprovalStatusChangeEvent body → 204default
POST
/listener/applicationOwnerAttributeValueChangeEvent
Client listener for entity ApplicationOwnerAttributeValueChangeEvent
applicationOwnerAttributeValueChangeEvent body → 204default
POST
/listener/applicationOwnerCreateEvent
Client listener for entity ApplicationOwnerCreateEvent
applicationOwnerCreateEvent body → 204default
POST
/listener/monitorStateChangeEvent
Client listener for entity MonitorStateChangeEvent
monitorStateChangeEvent body → 204default

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are Request (4 properties), Response (3 properties), Extensible (3 properties), TimePeriod (2 properties). Each schema is shown below with its type and property counts.

LogicalResourceRole
object
A logical Resource Role is a role given to a logical resource in a given context.
1 property
ApplicationOwnerAttributeValueChangeEvent
ApplicationCreateEventPayload
object
ApplicationCreateEventPayload
1 property
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
LightGeographicSubAddress
ApiProductOrderAttributeValueChangeEventPayload
object
ApiProductOrderAttributeValueChangeEventPayload
1 property
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
ApplicationOwnerCreateEventPayload
object
ApplicationOwnerCreateEventPayload
1 property
ApiProductOrderAttributeValueChangeEvent
DCSProductOrderItem
object
An identified part of the order. A product order is decomposed into one or more order items.
Addressable
object
Base schema for addressable entities
2 properties
ApplicationCreateEvent
ContactMedium
ApiPermissionSet
AttachmentRef
ApiDigitalIdentity
MonitorStateChangeEvent
ApiProductOrder
ApplicationCategoryType
string
Valid values for the category of the Application. Please refer to main Application stores in order to retrieve a more precise definition of the categories.
ISO31661Alpha2StandardIdentifier
Characteristic
Request
object
A response to a request
4 properties
Attachment
ApiConsumerPermission
Response
object
A response to a request
3 properties
ApplicationApprovalStatusChangeEvent
OAuth2ClientCredential
AssetGroup
object
Defines a group of assets (entities) to which access can be controlled. Specific subclasses allow definition in various ways (list of entities, queries, owners…
ApiProductOrderCreateEvent
ApplicationOwnerOrganization
ApplicationOwnerRelatedIndividual
ApplicationOwnerStatusType
string
Used to track the lifecycle status of the ApplicationOwner in Channel Partner IT. So this attribute is allowed to be contributed by the Channel Partner and pat…
LogicalResource
OrganizationIdentification
ApplicationOwnerCreateEvent
ApplicationApprovalStatusChangeEventPayload
object
ApplicationApprovalStatusChangeEventPayload
1 property
ApplicationAttributeValueChangeEventPayload
object
ApplicationAttributeValueChangeEventPayload
1 property
GCProductOrderItem
object
General Context ProductOrderItem that can be used as a Domain Specialization Order Item or as a non-specialised OrderItem.
MonitorStateChangeEventPayload
object
MonitorStateChangeEventPayload generic structure
1 property
ApplicationOwnerApprovalStatusChangeEvent
RelatedPartyRefOrPartyRoleRef
ApplicationOwnerRelatedOrganization
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
DpvOrganizationType
string
Valid values for a type of organization based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv.
Quantity
object
An amount in a given unit
2 properties
PartyRefOrPartyRoleRef
object
ApplicationOwnerRelatedLocalRepresentative
ResourceOperationalStateType
string
ResourceOperationalStateType enumerations; values defined by ITU X.731: 'disable': The resource is totally inoperable and unable to provide service to the user…
ApplicationAttributeValueChangeEvent
ApplicationOwnerApprovalStatusChangeEventPayload
object
ApplicationOwnerApprovalStatusChangeEventPayload
1 property
CharacteristicRelationship
ProductRef
object
A Product reference
ApplicationOwnerAttributeValueChangeEventPayload
object
ApplicationOwnerAttributeValueChangeEventPayload
1 property
ApiProductOrderStateChangeEventPayload
object
ApiProductOrderStateChangeEventPayload
1 property
ApplicationOwner
Monitor
ProductOrderStateType
string
Possible values for the state of the order
HeaderItem
object
An item typically included in a request or response
2 properties
EntityRef
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
PartyRef
object
A Party reference
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ApiProductOrderCreateEventPayload
object
ApiProductOrderCreateEventPayload
1 property
ApiProductOrderStateChangeEvent
ApiListAssetGroup
ExternalIdentifier
Application
Event
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyRoleRef
LightGeographicAddress
ApplicationOwnerPartyOrPartyRole
object
Schema that permits to identify an Individual or an Organisation in the Open Gateway context.
ApprovalStatusType
string
Valid values for an ApprovalStatus in the context of an approval process.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-gateway-notification-listener-api-openapi.yml Raw ↑

Other APIs GSMA Open Gateway publishes across the network.

GSMA Open Gateway Age Verification API
GSMA Open Gateway API Product API
GSMA Open Gateway API Product Order API
GSMA Open Gateway Application API
GSMA Open Gateway Application Owner API
GSMA Open Gateway Call Forwarding information retrieval API
GSMA Open Gateway Check Device Swap API
GSMA Open Gateway Check SIM swap API
GSMA Open Gateway Check Subscriber Tenure API
GSMA Open Gateway Connected Network Type API
GSMA Open Gateway Device reachability status API
GSMA Open Gateway Device reachability status subscription API
Where this information came from

This is an independent, third-party profile of GSMA Open Gateway notification listener 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.