---
sourceDocument: Yokohama Telecommunications Service Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/telecom-service-ops

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama Telecommunications Service Operations Management

ft:clusterId :

    - tsom

bundleId :

    - tsom

workflow :

    - Customer and Industry


---

# Handling external events using Telecommunications API

# Handling external events using Telecommunications API {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Handling external events using Telecommunications API

The Telecommunications API notification, part of the Telecommunications Alarm Management Open API application, enables ServiceNow customers to receive and respond promptly to external network system events within the ServiceNow AI Platform.
It simplifies event broadcasting by removing the need for point-to-point connections, allowing ServiceNow to ingest notifications from external systems to which customers are subscribed.
Show full answer Show less  

## Key Features

* **Event-Driven Architecture Support:** Supports Pub/Sub subscription model, Hermes Messaging Service, and Kafka Stream Connect to receive external notifications.
* **Flexible Subscription Model:** Customers can create topics and subscribe only to those relevant to their needs, ensuring tailored event handling.
* **Integration with Event Management:** Incoming notifications trigger event creation in the Event Management application, enabling consolidated dashboards and service-impact views.
* **Configurable Workflow:** Steps include creating topics, subscribing to topics, and activating the Telecommunications Alarm Management endpoint for receiving notifications.
* **Callback URL Usage:** External systems send notifications to a registered callback URL in ServiceNow, which initiates event creation workflows automatically.
* **User Role Management:** Administrators can assign roles to control access to API notification database tables, ensuring secure and appropriate access.

## Practical Configuration Steps

* **Create Topics:** Define topics manually or import from external systems to categorize incoming notifications.
* **Subscribe to Topics:** Select topics of interest to receive relevant notifications and register the subscription with a callback URL.
* **Activate Endpoints:** Enable the Telecommunications Alarm Management Open API endpoints in Workflow Studio to start receiving notifications and trigger event workflows.

## What Customers Can Expect

By implementing Telecommunications API notification, customers can streamline the integration of external network event data into their ServiceNow environment. This facilitates timely awareness and response to network issues through automated event creation and consolidated monitoring dashboards, improving service reliability and operational efficiency.  
Use the Telecommunications API notification to receive the external events that occurring in the customer network system so that you can promptly respond to them in the ServiceNow AI Platform.

## Introduction to Telecommunications API notification {#telecommunications-api-notification__section_wyw_yy1_dzb}

Telecommunications API notification is a feature available in the Telecommunications Alarm Management Open API application. The Telecommunications API notification enables ServiceNow to receive the incoming notifications that occurring in the external network system and responds to them in a timely manner. It enables the broadcasting of events to the external systems through
platform capabilities by eliminating the need for point to point connections.

Telecommunications API notification receives incoming notifications from the external systems that are subscribed on your network. When the notifications are received from the external system, you can create the events for the
responses by using the Event Management application. Based on the collected information, the Event Management provides dashboards showing a consolidated view of all service-impact events.

## Telecommunications API notification data model {#telecommunications-api-notification__section_qv3_1z1_dzb}

The following diagram shows the components in the data model for the Telecommunications API notification.
Figure 1. API notification data model  
The Telecommunications API notification enables ServiceNow to receive incoming notifications through the event-driven architectures such as the Publisher/Subscriber (Pub/Sub) subscription model, Hermes, and Kafka Stream Connect. While cloud customers have the flexibility to select between both architectures, on-premise customers are limited to using their own Kafka or Pub/Sub subscription model.

* To learn more about Stream connect for Apache Kafka Stream, see [Using Stream Connect for Apache Kafka](https://www.servicenow.com/docs/access?context=stream-connect-apache-kafka&version=yokohama&pubname=yokohama-integrate-applications&ft:locale=en-US).
* To learn more about Hermes Messaging Service, see [Hermes Messaging Service](https://www.servicenow.com/docs/access?context=hermes-messaging-service&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).
{#telecommunications-api-notification__ul_g3w_3b3_dzb}

In the Pub/Sub model, incoming notifications are categorized into topics. You use ServiceNow to publish the incoming notifications to these topics, and subscribers (customers) have the flexibility to select the topics to which they want to subscribe. This process enables subscribers to
select only those messages that align with their interests. For example, if there are 10 topics for incoming messages from the external system, a customer can opt to subscribe to two of them based on their requirement. Consequently,
when notifications are received from the external system, events are generated specifically for the two topics to which the customer has subscribed.

## Modeling the Telecommunications API notification workflow {#telecommunications-api-notification__section_wf3_bz1_dzb}

The following steps help to configure the Telecommunications API notification in the ServiceNow instance.  
1. [Create a topic](https://servicenow-prod.fluidtopics.net/EwKmRdxfs4i0FlBqwvD7Xg "Create a topic and publish the incoming notifications from the external system to the topic. By creating the topics, subscribers can select the topics to which they want to subscribe."): You can create topics either by manually typing the external message details or automatically collecting the available topics from the external system.
2. [Create a topic subscription](https://servicenow-prod.fluidtopics.net/gluWF80BA6WB8DKX4rZhHA "Subscribe to the topic in the ServiceNow AI Platform that you want respond to the incoming notification from the external system. By subscribing to the topic, the subscriber receives the notifications based on the topics that you subscribe to."): You subscribe to the available topics for incoming notifications from the external system, based on the customer preference. Additionally, you generate the callback URL and register the subscription.
3. [Activate Telecom Alarm Management endpoint](https://servicenow-prod.fluidtopics.net/6AqRNDOtmSsMX07iiOe9NA "Activate the endpoint of the Telecommunications Alarm Management Open API connection. By activating the endpoint, you receive the incoming notifications from the external system for the topic that you registered."): To receive responses from the external system, activate the subscribed endpoints of the Telecommunications Alarm Management Open API connection in the Workflow Studio.
4. Provide the callback URL to the external system for receiving notifications. Customer can also reuse the callback URL. When requests from TMF 688 hit the Callback URL, it initiates the Default Alarm Event Notification Trigger flow to create an event.

   External trigger definitions create, update, and delete events. For more information about the functions to handle Event Notification Management Open API requests, see [Event Notification Management Open API](https://www.servicenow.com/docs/access?context=event_open-api&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US). See also [TMFTopicEventAPIUtilOOB - Scoped](https://www.servicenow.com/docs/access?context=tmftopiceventapiutiloobScopedAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US).
{#telecommunications-api-notification__ol_xts_cz1_dzb}

This workflow creates an event in the Event Management application. To learn more about using Event Management, see [Event Management](https://www.servicenow.com/docs/access?context=c_EM&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).
* **[Create a topic](https://servicenow-prod.fluidtopics.net/EwKmRdxfs4i0FlBqwvD7Xg)**   
  Create a topic and publish the incoming notifications from the external system to the topic. By creating the topics, subscribers can select the topics to which they want to subscribe.
* **[Create a topic subscription](https://servicenow-prod.fluidtopics.net/gluWF80BA6WB8DKX4rZhHA)**   
  Subscribe to the topic in the ServiceNow AI Platform that you want respond to the incoming notification from the external system. By subscribing to the topic, the subscriber receives the notifications based on the topics that you subscribe to.
* **[Activate Telecom Alarm Management endpoint](https://servicenow-prod.fluidtopics.net/6AqRNDOtmSsMX07iiOe9NA)**   
  Activate the endpoint of the Telecommunications Alarm Management Open API connection. By activating the endpoint, you receive the incoming notifications from the external system for the topic that you registered.
* **[Telecommunications API notification user roles](https://servicenow-prod.fluidtopics.net/KlVkJTv8wji83_aylIUfYQ)**   
  Administrators can assign user roles to grant access to the API notification database tables. The following standard roles for the Topic \[sn_api_notif_mgmt_topic\] and Topic Subscription \[sn_api_notif_mgmt_subscription\] tables are included in the ServiceNow system.

