Inbound Webhooks

Overview

The LimeCall Inbound Webhook allows you to capture data from external sources and automatically trigger workflows, such as scheduling an auto callback for your leads. This webhook is ideal for integrating LimeCall with forms, CRMs, or other platforms to ensure timely follow-ups and streamlined lead management.

---

Key Features

• Capture detailed lead information, including name, email, phone number, and custom fields.

• Trigger auto callbacks to connect with leads immediately after capturing their details.

• Automate lead qualification and routing for enhanced sales efficiency.

• Route to the Right Team: Use the team_id field to assign leads to specific teams for better workflow management.

• Setup Custom Caller ID: Customize the caller ID for callbacks to display a professional, recognizable number.

• Capture Lead Data: Collect critical lead details such as name, phone number, email, and additional metadata.

Use Cases

1. Form Submission Capture: Automatically capture leads from your website forms and trigger instant callbacks.

2. Auto Callback on Form Submissions: Ensure immediate follow-up with leads as soon as they submit their details.

3. Integrate with Existing Forms and Apps: Capture leads from existing forms or third-party applications like Typeform, Gravity Forms, or HubSpot.

4. Facebook Lead Form Ads: Capture leads directly from Facebook lead generation ads and trigger auto callbacks.

5. Landing Pages for Campaigns: Automatically follow up with leads from marketing campaign landing pages.

6. Multi-Team Assignment: Route leads to specific sales or support teams based on the team_id for efficient handling.

7. Custom Sales Campaigns: Use custom fields like industry or page_url to create targeted campaigns.

8. Real-Time Lead Qualification: Qualify leads based on custom rules, such as form responses or specific attributes, and trigger callbacks only for qualified leads.

9. Event Registrations: Auto-call leads who register for webinars, demos, or events.

---

How It Works

1. LimeCall listens for data posted to the webhook endpoint.

2. When a request is received, LimeCall captures the information and processes it based on the provided fields.

3. If the auto callback option is enabled, LimeCall will initiate a callback to the provided phone number.

---

Request Method

POST (Content-Type: application/json or form-data)

---

Required Headers

Header	Value	Description
Accept	application/json	Specifies the response format.
Authorization	Bearer {token}	API token for authenticating the request.

---

Request Body Parameters

Parameter	Type	Required	Description
hookName	String	Yes	The unique name for the webhook.
name_field	String	Yes	Captures the name of the lead.
country_code_field	String	Yes	Captures the country code of the lead's phone number.
phone_field	String	Yes	Captures the phone number of the lead.
email_field	String	No	Captures the email address of the lead.
company_name_field	String	No	Captures the name of the company associated with the lead.
ip_address_field	String	No	Captures the lead's IP address.
industry_field	String	No	Captures the industry of the lead.
message_field	String	No	Captures any custom message or note associated with the lead.
size_field	String	No	Captures the company size (e.g., small, medium, large).
page_url_field	String	No	Captures the URL of the page where the data was submitted.
page_name_field	String	No	Captures the name or title of the page.
date_submitted_field	String	Yes	Records the date the form or data was submitted.
time_submitted_field	String	Yes	Records the time the form or data was submitted.
is_auto	Integer	No	Enables auto callback (1 for enabled, 0 for disabled).
status	Integer	Yes	Indicates the status of the webhook (1 for active).
team_id_field	String	No	Captures the team ID to route the lead appropriately.

Sample Request

Example Payload:

jsonCopyEdit{
  "hookName": "captureLeadWebhook",
  "name_field": "John Doe",
  "country_code_field": "+1",
  "phone_field": "1234567890",
  "email_field": "[e-mail]",
  "company_name_field": "Acme Corp",
  "ip_address_field": "192.168.1.1",
  "industry_field": "Software",
  "message_field": "Looking for a demo.",
  "size_field": "Medium",
  "page_url_field": "https://example.com/demo",
  "page_name_field": "Demo Page",
  "date_submitted_field": "2025-01-30",
  "time_submitted_field": "14:30:00",
  "is_auto": 1,
  "status": 1,
  "team_id_field": "team_001"
}

---

Response

Upon successful data capture, the webhook will return a 200 OK response with the following payload:

jsonCopyEdit{
  "status": "success",
  "message": "Webhook data captured successfully",
  "auto_callback": "initiated"
}

If the auto callback fails, the response will include an error message:

jsonCopyEdit{
  "status": "error",
  "message": "Failed to initiate auto callback",
  "details": "Invalid phone number format"
}

---

Auto Callback

When is_auto is set to 1, LimeCall will automatically initiate a callback to the lead's phone number. The callback process:

1. Verifies the validity of the phone number.

2. Calls the lead immediately or schedules the callback based on business hours.

---

Step 1: Create a New Webhook URL

1. Log in to the Dashboard

2. Navigate to the Webhooks Section

   • From the dashboard, click on Settings in the sidebar.

   • Select Webhooks from the settings menu.

3. Create a New Webhook

   • Click the "Create Webhook" button.

   • Enter the following details:

     • Webhook Name: Provide a unique name for your webhook (e.g., "Facebook Lead Form").

     • Trigger Events: Choose events like form submissions or lead generation that will trigger the webhook.

     • Custom Fields: Add custom fields (e.g., industry, page_url) if required.

     • Enable Auto Callback: Toggle on Auto Callback if you want immediate follow-up calls.

4. Save the Webhook

   • Click Save or Create Hook to generate your webhook URL.

   • Copy the generated webhook URL displayed on the dashboard.

---

Step 2: Use the Webhook URL in Your App

1. Integrate the URL into Your Application

   • Paste the copied webhook URL into your app or third-party platform's webhook settings.

   • For example:

     • Forms: Add the webhook URL to the form’s “Submission URL” field.

     • Facebook Lead Ads: Go to your Facebook Lead Ads settings and set the webhook URL as the endpoint for lead capture.

2. Configure Payload Format

   • Ensure your app sends data in the expected format. Refer to the Webhook Fields section above for required parameters.

3. Test the Integration

   • Trigger an event (e.g., form submission or lead ad) to test the webhook.

   • Verify the data is captured correctly in LimeCall by checking the webhook logs.

Testing the Webhook

1. Use the LimePhone dashboard or a tool like Postman to send a test payload to the webhook endpoint.

2. Verify that the data is captured and processed correctly.

3. Check the auto callback logs in the LimeCall dashboard to confirm the call status.

---

Best Practices

• Secure Data: Use HTTPS for your endpoint and validate the Authorization token.

• Validate Input: Ensure all required fields are provided in the correct format to avoid errors.

• Monitor Webhooks: Regularly review webhook logs for successful and failed events.

• Retry Logic: Implement retry mechanisms for failed callbacks or submissions.

---

Need Help?

If you encounter any issues, please contact our support team at [e-mail]