> For the complete documentation index, see [llms.txt](https://help.boomerang3.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.boomerang3.com/boomerang-3-domain-administrator-manual/admin/alarms/alarm__alarm_groups/alarm-distribution/webhook.md).

# Webhook

Webhook is one of the alarm distribution methods in B3.

A webhook is an automated, event-driven way for one application to send real-time data to another via an HTTP POST request to a unique URL. Instead of an application constantly asking for updates ([polling](https://www.google.com/search?sca_esv=8e23599b05dcda53\&sxsrf=AE3TifM-Yi3NXiOuynYZsb7zoiP9wyZ08g%3A1756135073041\&q=polling\&sa=X\&ved=2ahUKEwj2-NL5oKaPAxUWQvEDHWtyNl8QxccNegQIDxAB\&mstk=AUtExfCEDorqor_LPMRaumB_qIsYjR-nxzqIg5w3WxUvm_POV0d9TaWNVHjfoQyt34WHUoMpRWnRjtfM0Imab3Y_Kk4EcEEpzNQDqj95stWCuWtF-Gs2U_r-WA6AQWko7inYBg4zNjxE-G4Do2IC4d6LcDTa9JkdvvXRdk0b5mreE2OHKGXB0u6B_s43cmwjhZJwMdzbjkeq4MMgmM8Iow2pG6F40ms_5a_wDp5Iq7jWY-Evo92gbyiqIs-GaropPTd_hK_wg9lKKRtGX1FGDgB_A3vB\&csui=3)), a webhook allows the source application, which in our case is B3, to "push" information to a destination application the moment a specific event occurs. This event in case of B3 is a detection of an active alarm.

At present, webhooks are used to distribute alarms via SMS using B3 SMS devices described in [T-SMS Device Installation Manual](https://help.boomerang3.com/b3-sms-device-installation-manual/).

To create a webhook:

1. Click "+" button in the Webhooks part of the Alarm Group details form that you can open by [Edit Alarm group](/boomerang-3-domain-administrator-manual/admin/alarms/alarm__alarm_groups/edit-alarm-group.md).

<figure><img src="/files/IHuFGLrI3TkEwuUxINNt" alt=""><figcaption></figcaption></figure>

2. A webhook form is opened.

<figure><img src="/files/fFSrhn0kDPsMZSCZUF98" alt="" width="458"><figcaption></figcaption></figure>

3. Enter webhook name, API Unique ID, Payload URL, mark "Include user phone numbers" and "Active".

<figure><img src="/files/w8xVxnswHUCejHCRgIfS" alt=""><figcaption></figcaption></figure>

Click the icon after Webhooks form title to check the JSON-payload format.

<figure><img src="/files/7isedSQVzK9zWsj2EVcl" alt=""><figcaption></figcaption></figure>

&#x20;The form fields are described in the table below.

<table><thead><tr><th width="164">Field</th><th width="253">Description</th><th>Default value</th></tr></thead><tbody><tr><td>Name</td><td>Webhook name.</td><td>No default value, must be unique.</td></tr><tr><td>API Unique ID</td><td>Defines the B3 SMS device which shall send the SMS.</td><td>No default value, must be unique. The same string is entered into the B3 SMS device as described in <a data-mention href="/spaces/sp4j9Tn2xGb8D5438KRm">/spaces/sp4j9Tn2xGb8D5438KRm</a></td></tr><tr><td>Payload URL</td><td>Points to API that receives the webhook POST. A fixed URL pointing to B3 SMS server.</td><td><a href="http://10.50.33.12/api/b3.asp">http://10.50.33.12/api/b3.asp</a></td></tr><tr><td>Signature Secret</td><td>Signature Secret. A fixed value.</td><td>icujira2025</td></tr><tr><td>Include user phone numbers</td><td>If checked then the POST contains user mobile phone number.</td><td>Must be checked.</td></tr><tr><td>Include user emails</td><td>If checked then the POST contains user emails.</td><td>Not checked in case of webhook used for B3 SMS devices. Planned for future use.</td></tr><tr><td>Active</td><td>A checkbox that enables a given webhook.</td><td>Must be checked for the webhook to work.</td></tr></tbody></table>

4. Click "Save" and sign.

Multiple webhooks can be defined in an alarm group.&#x20;

<figure><img src="/files/72d25aAQnWKksfkDqEVS" alt=""><figcaption></figcaption></figure>

The icon on the left shows if the webhook is active. In the example above Designgården is not active and DGC1 is active.

The number of POSTs distributed by a given webhook is also shown.

The check mark shows the status of the last POST. At the end of each webhook row there are "Edit" and "Delete" icons.


---

# 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://help.boomerang3.com/boomerang-3-domain-administrator-manual/admin/alarms/alarm__alarm_groups/alarm-distribution/webhook.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.