> For the complete documentation index, see [llms.txt](https://doc1.antgst.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc1.antgst.com/help-center/technology-access/api/webhooks.md).

# Webhooks

Webhooks Configuration – Receive Real-Time Event Notifications

#### 1. Where to Find It

<figure><img src="https://1063803597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeMT6j6yprSW9Vl5MB4Oi%2Fuploads%2Fgit-blob-03c21a027e5646f0745ac03ec129508cbe6c2046%2Fimage%20(4).png?alt=media" alt=""><figcaption></figcaption></figure>

To configure webhook callbacks:

1. Log in to the console and go to the **Dashboard** (Home page).
2. Under **Technology Access**, click on **"Webhook"**.
3. You will be redirected to the **Webhooks Configuration** page.

> 📌 Tip: This feature is available for users with API integration enabled.

***

#### 2. Function Description

The **Webhooks Configuration** page allows you to set up callback URLs that receive real-time event notifications from our platform. When specific events occur (e.g., SMS delivered, call completed), we will send a POST request to your specified URL.

<figure><img src="https://1063803597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeMT6j6yprSW9Vl5MB4Oi%2Fuploads%2Fgit-blob-e7f4746a94003f42047f7e73675776a3d20d6374%2Fimage%20(5).png?alt=media" alt=""><figcaption></figcaption></figure>

**Supported Event Types:**

* **Marketing SMS**: Notify when marketing messages are sent or delivered
* **Verification Code SMS**: Notify when OTPs are sent or verified
* **Voice Code**: Notify when voice-based verification codes are triggered
* **Automatic Outbound Call**: Notify when outbound calls are initiated
* **CDR Call Record**: Receive call detail records (duration, status, etc.)
* **Call Recording**: Get access to recorded audio files (if enabled)
* **Status Detection**: number Status

**Key Features:**

* **Add Callback URL**: Click **"Add callback URL"** to register a new endpoint
  * Enter your target URL (must be HTTPS)
  * Select one or more event types to trigger the callback
* **Edit / Delete**: Modify or remove existing webhook configurations
* **Copy**: Copy the URL for quick use
* **Test**: Send a test POST request to your URL to verify connectivity
  * Useful for debugging and ensuring your server is reachable

> ✅ All webhooks are delivered via **HTTPS POST** with JSON payload.\
> ⚠️ Ensure your server can handle incoming requests and return `200 OK` to confirm receipt.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc1.antgst.com/help-center/technology-access/api/webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.