Skip to content
English
Sign in
Contact us
  • There are no suggestions because the search field is empty.

Integration Guide: Understanding the Webhook Flow in Meera AI

In this article, we'll cover the basics of how webhooks work and provide a specific example using Meera AI’s webhook integration, illustrating the flow of data between systems.

What is a Webhook?

API Documentation

A webhook is a way for one system to send data to another system in real time whenever a specific event occurs. It works by making an HTTP POST request to a predefined URL, passing the relevant data (often in JSON format) to the receiving system.

Example Webhook Flow

1. Register your Webhook URL 

  • For real-time updates, simply give us your CRM's webhook URL, and Meera.ai will route the data to it.

2. Event Occurs

  • When a lead event occurs, such as a lead being updated or moved through a campaign, Meera AI triggers the webhook.

3. Data Sent via HTTP POST

  • Meera AI sends an HTTP POST request to the webhook URL. This request contains a JSON payload with all the relevant data about the lead and its status.

Example JSON Payload:

4. Receiving and Processing Data in Your CRM

  • Your CRM will receive the JSON payload, process it, and take the appropriate action.

Key Meera AI Statuses in Webhook Responses

The webhook payload from Meera AI can include different lead statuses, indicating the current state of the lead. Below are some common statuses and their meanings:

  • NotDone: Lead has not yet received the message or is already marked as DNC (Do Not Contact).
  • Undelivered: The SMS message to the lead was not delivered.
  • Responded: Lead has responded to the campaign.
  • Scheduled: An appointment is scheduled for the client based on the lead's request.
  • Called: The lead was called, but there was no transfer.
  • Transferred: The call was transferred, but lasted between 30-90 seconds.
  • DNC: Lead is marked as Do Not Contact, and no further communication will be initiated.
  • Converted: The call was successful and lasted more than 90 seconds.
  • NoRepResponse: The lead requested an appointment, but no representative was available.
  • Delivered: The message was delivered, but no response was received.
  • ClosedAfterFollowup: Maximum follow-up attempts have been made, and the lead is marked as exhausted.
  • BadPhone: The phone number is invalid or no longer exists.
  • RepCall30SEC: The call was transferred, but it lasted less than 30 seconds.
  • Posted: The lead was successfully inserted into the campaign but is yet to be processed further.

 

🧩 Further Reading

To learn more about webhooks and lead status notifications, check out our guide: Webhook Integration: Understanding Lead Status Notifications

 

📞 Need Help?

If you have any questions or would like to proceed with setting up your webhook, please email us at help@meera.ai