QuickReply.ai Official Documentation
  • Introduction
    • QuickReply.ai
  • Getting Started
    • Installation
      • Install QuickReply on Shopify Store
  • Drip Campaigns
    • Drip Campaigns by QuickReply.ai
  • Templates Guide
    • Creating a standard template for WhatsApp
    • Creating a carousel template for WhatsApp
  • Broadcasts Guide
    • Creating a Broadcast
    • Creating a Broadcast using Carousel Template
    • Broadcasts Reports
    • Recover failed messages in a WhatsApp broadcast
      • How does Smart Utility Fallback Work?
  • Click-to-WhatsApp Ads
  • Two-Factor Authentication Guide
  • Uninstallation / Migration
    • Migrating from WhatApp Business API to WhatApp Mobile Apps
  • Customer profies
    • Export Customer Profiles
  • API Documentaion
    • Sync Contacts to CRM API
    • WhatsApp Chat API
    • Send Template API
    • Trigger Drip Campaign API
    • External CRM Integration
    • Fetch Campaign Messages Stats
    • Browse Abandoned Recovery Integrations
  • WhatsApp Green Tick
    • How to get a Green Tick on your WhatsApp number
  • Analytics
    • Order and Revenue Attribution
    • Google Analytics Report
  • Miscellaneous
    • Types of WhatsApp Messages
    • Quality Ratings & Messaging Limits
    • FAQs
    • Account health and blocking
    • What formats of media / image / video or audio are supported on WhatsApp Business API?
  • Segments Guide
    • Customer Segments
      • Customer Segment Filters
  • WhatsApp Display Name & WhatsApp Profile
    • WhatsApp Display Name
  • Customizations
    • Notifications
  • How to
    • Subscribe to push notifications on browser
    • Enable/Disable different notifications for agents
    • Unblock notifications permission
    • Install QuickReply on Mobile
  • Miscellaneous
    • QuickReply.ai - Data privacy and security
  • Message Template Guidelines
  • Video Tutorials on WhatsApp for E-commerce
  • Quality Ratings and Messaging Limits of WhatsApp Business API
  • Phone number requirements, Business Profile & Migration
  • Phone number and profile Messaging Limits FAQs
  • How to enable Facebook Business verification option
  • How to get Facebook Business Manager verified
  • Language Supported
  • Trusted Domains
  • Integration
  • Chat Widget
  • Channels
  • Team
  • How to Collect WhatsApp Business Opt-Ins for your Shopify Store?
  • FAQ Training
  • Keyword Training
  • How to export leads captured on chat by QuickReply.ai?
  • Merge Fields for WhatsApp Campaigns
  • How to send WhatsApp message using REST API - QuickReply.ai
  • How to share Facebook Business Manager Access to QuickReply.ai
  • What are the media file size limits and aspect ratio in WhatsApp Business API?
  • FAQ Training
  • How to integrate Razorpay for COD-to-Prepaid WhatsApp Campaigns?
  • How to integrate CashFree for COD-to-Prepaid WhatsApp Campaigns?
  • How to integrate PayU for COD-to-Prepaid WhatsApp Campaigns?
  • INTEGRATION
    • Social
      • Instagram DM & Messenger
        • Link Facebook page to Instagram account
        • Enable "Allow access to messages" for Instagram DM
    • Analytics
      • Meta Pixel
      • Google Analytics 4 (GA4)
    • CRM
      • HubSpot CRM
      • Zoho CRM
      • LeadSquared CRM
      • Salesforce
        • How to Enable WhatsApp Chat in Salesforce
        • How to Automatically Create Leads from New Chats and Get Notifications in Salesforce
    • CDP
      • MoEngage
  • FLASH RESPONSES
    • Flash Responses
    • Create Flash Response
    • Using Flash Response
  • FAQs
    • FAQ list
      • WhatsApp Messenger
        • "This business is now working to manage this chat", what does this mean?
      • Media
        • How can I send images as an album in WhatsApp Business API?
      • Blocking/ Unblocking
        • Can I reject or block incoming messages to my WhatsApp number on QuickReply.ai?
        • How to block an end-user from sending and receiving messages from your WhatsApp number?
        • Can users block or report WhatsApp Business API number?
Powered by GitBook
On this page
  • Overview
  • How it works
  • Webhook API requirements for syncing Contacts
  • There are two key webhooks:
  • New Contact Webhook
  • Update Contact Webhook
  • Example Requests
  • 1. Create a new Contact
  • 2. Update an existing Contact (optional)
  • How to implement Contact Syncing
  • FAQs

Was this helpful?

  1. API Documentaion

Sync Contacts to CRM API

The "Sync Contacts to CRM API" allows you to seamlessly integrate QuickReply with your in-house or custom-built or any CRM system.

Overview

The Sync Contacts to CRM API allows seamless synchronisation of contact data between QuickReply.ai and your CRM system. This API facilitates the creation and updating of contact records, ensuring that your CRM always has the most accurate and up-to-date information.


How it works

  1. Creating a New Contact:

    • When QuickReply.ai detects a new Contact, it sends a POST request to the New Contact Webhook. This request includes the Contact's details.

    • The CRM responds with a unique Contact identifier, which QuickReply.ai stores internally.

  2. Updating an Existing Contact:

    • For any updates to a contact's information, QuickReply.ai sends a POST or PUT request to the Update Contact Webhook. This request includes the Contact identifier and the updated contact details.

This process ensures that both new and updated contact information is accurately reflected in your CRM.


Webhook API requirements for syncing Contacts

  • QuickReply.ai uses webhooks to communicate with your CRM system.

  • Webhook endpoints should accept JSON payload/FORM post in the request body.

  • You can authorise your API calls with fixed Authorization keys in headers, query string or body. This is optional.

There are two key webhooks:

New Contact Webhook

  • Webhook URL: [Your Webhook URL]

  • Description: Triggered when a new contact is detected. This webhook creates a new contact in your CRM.

  • Payload Example:

{
  "event": "new_contact",
  "data": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "source": "website"
  }
}
  • Response: The CRM should respond with a unique Contact identifier, which QuickReply.ai stores for future reference.

Update Contact Webhook

  • Webhook URL: [Your Webhook URL]

  • Description: Triggered when there is an update to an existing contact. This webhook updates the contact information in your CRM using the stored Contact identifier.

  • Payload Example:

{
  "event": "update_contact",
  "data": {
    "contact_id": "12345",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+0987654321",
    "status": "contacted"
  }
}

Note:

  1. You can use the same web-hook URL for both new Contact and update Contact events if your endpoint can differentiate between the two based on the payload.

  2. The payload structure is quite flexible and can be customised by QuickReply.ai's team on request as per the CRM requirements.


Example Requests

1. Create a new Contact

curl -X POST [Your Webhook URL] \
-H "Content-Type: application/json" \
-d '{
  "event": "new_contact",
  "data": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "source": "website"
  }
}'

You can create endpoint like to this to create a contact in your CRM.

This body will have all the params captured in the Contacts's Profile.

2. Update an existing Contact (optional)

curl -X POST [Your Webhook URL] \
-H "Content-Type: application/json" \
-d '{
  "event": "update_contact",
  "data": {
    "contact_id": "12345",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+0987654321",
    "status": "contacted"
  }
}'

How to implement Contact Syncing

  1. Once you are ready with the API endpoints, please share the same with your point of contact in QuickReply.ai's team or write to help@quickreply.ai to get it updated.

  2. Our team will schedule a call with your team to setup the syncing and get it implemented.

  3. Time to implement is usually 5 business days.


FAQs

Do the contacts sync in real-time?

The contacts are synced in near real-time. The platform waits for 5 mins before the syncing is done after any update received from the end-user.

Can the sync-time frequency be reduced?

We recommend a 5-min inactivity delay before the syncing to avoid too many API calls to your custom CRM. However, if you have a need of a faster sync, we can enable that at an additional charge. Please write to help@quickreply.ai for this request.

Can I use the same webhook URL for both new Contacts and updates?

Yes, you can use the same web-hook URL for both types of events if your CRM used either of email or phone number as the Contact identifier

PreviousExport Customer ProfilesNextWhatsApp Chat API

Last updated 8 months ago

Was this helpful?