> ## Documentation Index
> Fetch the complete documentation index at: https://docs.converse.vitxi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Learn all about webhooks in Vitxi Converse

## **What are Webhooks?**

A **webhook** is a way for one app to automatically send data to another app when something happens. Instead of checking for updates all the time, the receiving app gives a special URL, and the sending app sends information to that URL as soon as the event occurs. This helps automate tasks, keep data updated in real-time, and connect different systems without manual work.

***

### **Benefits of Using Webhooks in Vitxi Converse**

The following are the benefits of using webhooks on Vitxi Converse:

1. **Receive instant alerts** on message failures, subscription expiries, and account issues.
2. **Trigger automated workflows** based on real-time message and account events.
3. **Monitor platform activity** with actionable insights on usage and performance.
4. **Integrate seamlessly** with CRMs, marketing tools, and internal systems.

***

### **How to use Webhooks on  Converse:**

1. Log into your Vitxi Converse account, and then go **Developer** section under the More section.
2. Click on the third tab to access the "Webhooks" section.

   <img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-1.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=bea219cbad845856e6ba492993bfb15c" alt="189 Webhooks  Converse Resource Centre 1 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-1.png" />
3. Here, the user has the options to configure webhooks for 3 types, WhatsApp, Instagram and Account Level.
4. Click on a card(WhatsApp, Instagram or Account Level) to configure the section.
5. Click on "Subscribe Webhooks".

   <img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-2.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=70b1832088ab44a9f5a1d12885508918" alt="189 Webhooks  Converse Resource Centre 2 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-2.png" />
6. A small popup window will open up. Enter your Webhook Endpoint, and verification key. Then, select the bots that you want the webhooks to be triggered for.

   <img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-3.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=979650db12c29c887f7ea6d9dc2c3302" alt="189 Webhooks  Converse Resource Centre 3 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-3.png" />
7. Once selected, the webhooks will be configured. Now, we can go into the specifics of each and select the ones to turn on.

***

### **WhatsApp Webhook's**

<img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-4.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=4a3ad1dc44297ba352d3633b26f79dd1" alt="189 Webhooks  Converse Resource Centre 4 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-4.png" />

1. There are many webhooks that have been created for WhatsApp. Some of them are as follows:

| Failed Message              | <br />Tells when a message could not be delivered                                                                                          |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Account Alerts              | Tells when your account does not meet our notability requirements. You can edit the display name and submit another request after 30 days. |
| Account Review Update       | Tells when account review request gets approved.                                                                                           |
| Account Update              | Update on the business verification of the WhatsApp account.                                                                               |
| Business Capability Update  | Updates on the max daily limits per day                                                                                                    |
| Business Status Update      | Updates the status of the business                                                                                                         |
| Template Quality Update     | Updates on the template quality.                                                                                                           |
| Template Status Update      | Tells of the approval status of the template.                                                                                              |
| Messages                    | <br />Tells of the messages that are recieved.                                                                                             |
| Phone Number Name Update    | Updates you when the name related to a phone number is updated                                                                             |
| Phone Number Quality Update | Tells of the plan quality of a new user.                                                                                                   |
| Security                    | <br />Tells information regarding the security of the PIN's.                                                                               |
| Template Category Update    | Updates the template category.                                                                                                             |

2. To edit any webhook, click on the "Edit Webhook Subscription" button.
3. To disconnect the webhook, turn off the status of the webhook. To disconnect all the webhooks status, click on the "Unsubscribe Webhooks" button and confirm the unhook process.

### **Instagram Webhook**

<img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-5.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=2db6ee597f23f107a7490126076fc402" alt="189 Webhooks  Converse Resource Centre 6 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-5.png" />

1. Instagram webhooks work similar in manner to WhatsApp Webhooks.
2. To edit any webhook subscripton, click on the "Edit Webhook Subscription" button.
3. To disconnect the webhook, turn off the status of the webhook. To disconnect all the webhooks status, click on the "Unsubscribe Webhooks" button and confirm the unhook process.

   <img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-6.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=531ec4c6000150cae23c2c39f4803ac6" alt="189 Webhooks  Converse Resource Centre 6 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-6.png" />

### **Account Level Webhooks**

<img src="https://mintcdn.com/vitxiconverse/cQKdMmNDcuzMEdWR/images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-7.png?fit=max&auto=format&n=cQKdMmNDcuzMEdWR&q=85&s=26055958b402bc8f138e42474a59ca28" alt="189 Webhooks  Converse Resource Centre 7 Pn" width="1806" height="1020" data-path="images/how-botpenguin-works/webhook/189.webhooks__Converse_resource_centre-7.png" />

| **Webhook Name**             | <br />**Use Case**                                                                                                                                                                                       |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Message limit exhausted      | <br />Notifies the customer when their available message quota has been fully utilized. Customers can customize this notification to trigger when a certain percentage of their plan has been exhausted. |
| Conversation limit exhausted | Alerts the customer when their WhatsApp conversation limit is reached.                                                                                                                                   |
| Plan expired                 | Sends a notification when the customer's subscription plan has expired.                                                                                                                                  |
| Account freeze               | Notifies the customer when their account is temporarily frozen due to non-payment or policy violations.                                                                                                  |

### **FAQ's**

These are the commonly asked questions regarding Webhooks:

<AccordionGroup>
  <Accordion title="What are webhooks in  Converse?">
    Webhooks are automated callbacks that notify your system in real-time when specific events occur on  Converse, such as message delivery failures or subscription changes.
  </Accordion>

  <Accordion title="Which platform do  Converse webhooks support?">
    Webhooks are supported for WhatsApp, Instagram, and application-level events within the  Converse ecosystem.
  </Accordion>

  <Accordion title="What kinds of events can trigger a webhook?">
    Events include failed message delivery, auto-reply execution, message limit exhaustion, conversation usage updates, subscription expiry, and account freezes.
  </Accordion>

  <Accordion title="Are webhooks real time?">
    Yes.  Converse webhooks are designed to send event notifications immediately as they occur.
  </Accordion>

  <Accordion title="What format does the webhook payload use">
    Webhook payloads are sent in JSON format, containing structured data about the triggered event.
  </Accordion>

  <Accordion title="How can I test if my webhook is working?">
    Converse provides testing options within the webhook configuration section, allowing you to simulate event triggers and validate your endpoint setup.
  </Accordion>

  <Accordion title="What should I do if my webhook endpoint fails?">
    Ensure your endpoint URL is active and accessible.  Converse may retry failed deliveries, but persistent failures will require you to debug and update your configuration.
  </Accordion>
</AccordionGroup>