For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Webhook

Get the Webhook Configuration

get

Returns the Webhook URLs configured on the edge.

What is webhook URL A webhook URL is a specific URL endpoint that allows one system to send real-time data to another system automatically. It is a type of API used to send updates or notifications when certain events occur. Rather than constantly polling for updates, a system can be set up to "listen" for events and automatically trigger actions when those events happen.

When a specific URL is set to "true", the system will trigger a webhook notification and send relevant data to the designated endpoint whenever the corresponding event occurs.

cdr url - When CDR events occur, they will send alerts to webhook. s1ap url - When certain s1ap events occur, it will send alerts to webhook. Ex. "s1 setup request/response" etc. s6a url - When certain s6a events occur, it will send alerts to webhook. Ex. "hss disconnect/connect" etc. uesubs url - When Subscriber attach detach events occurs will send alerts to webhook.

Responses
200

Retrieved Webhook Configurations successfully

application/json
get/webhook
GET /api/webhook HTTP/1.1
Accept: */*
200

Retrieved Webhook Configurations successfully

{
  "alerts": {
    "cdr": {
      "enabled": false,
      "webhook_url": "https://webhook.site/a113e532-8cb3-4146-bb95-05648dbeac49"
    },
    "s1ap": {
      "enabled": true,
      "webhook_url": "https://webhook-test.com/124fd87eaa370f47f94aa7a963e2b8c0"
    },
    "s6a": {
      "enabled": true,
      "webhook_url": "https://webhook.site/a113e532-8cb3-4146-bb95-05648dbeac49"
    },
    "uesubs": {
      "enabled": true,
      "webhook_url": "https://webhook-test.com/6edfd0a186555cb79e7fa4ddf310ad17f"
    }
  }
}

Last updated

Was this helpful?