LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
1.0.0
1.0.0
  • Acquire Developers Hub
  • Acquire
    • Acquire Build Requirement
      • Requirement For Acquire
      • Acquire Speedtest
  • JS API
    • JS Live Chat API
      • Description
      • Installation
      • Visitor
      • Thread
      • Conversation
      • User Verification
    • Quick Link Support
      • One Click Button
      • Social Media Share
    • Backend JS SDK
      • Setup Backend JS SDK
      • Demo Backend SDK
    • Advanced
      • Widget UI
      • Reference
  • Co Browse APIs
    • Acquire Co Browse
      • Co Browse API
  • Acquire API Events
    • WebRTC Related Events
  • iOS
    • SDK Setup Guide
      • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Manual Setup iOS
      • Acquire Account ID
    • SDK Configuration Example
    • iOS Cobrowse
    • Theme Setting
    • iOS Push Notifications
    • Verify your users
  • Android
    • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Start using Acquire
    • Acquire APIs
    • Acquire Delegates
    • Custom UI/widget
    • Cross Platform Integrations
  • Webhook API
    • Webhooks Basic
      • Introduction
      • Webhook Integrate Steps
      • Webhook Format
    • Webhook Events
      • On Chat Start
      • On Chat Accept
      • On Chat Message
      • On Chat Close
  • REST APIs
    • OAuth
      • Authorization
      • Tracklog
    • Profiles API
      • Profile List
      • Thread
      • Feedback
      • Profile Details
      • Message
      • Tags
      • Profile Agents
      • Campaigns
      • Profile Add Update
      • Profile Delete
      • Profile Visit History
      • Sender Emails
    • Chat
      • Chat Notes
    • Analytics
      • Chat Statistics
      • Team Analytics
      • Conversion Rate
      • Chat Tag
      • Co browsing
    • Agent
      • Agents List
      • Agent add
      • Edit / Get-agent
      • Update
    • Trigger
      • Triggers List
      • Triggers Detail
    • Operating Hours
      • Save Operating Hours
      • Get Operating Hours
    • Cobrowse
  • Chatbot API
    • Chat Bot
      • Integrate Your Chatbot
      • Dialog Flow V1 Chat-Bot
      • Dialog Flow V2 Chat-Bot
      • Dialog Flow Fulfillment & Custom Response
      • IBM Watson Integration
      • Amazon Lex Bot
      • Azure's QnA Maker
      • Webhook Calling & User Verification
      • Webhook For Reset Password
  • Knowledge Base APIs
    • Help Docs Setup
      • Get FAQ Categories
      • Get Setup Details
      • Get Side List
      • Get Article
      • Get Recent Article
      • Get Categorized Articles
      • Get Suggestion
  • Errors
    • API Error Handling
      • HTTP Responses
Powered by GitBook
On this page
  1. Webhook API
  2. Webhooks Basic

Webhook Format

Each webhook is an HTTP POST request made to the URL that you provide in the web app. The request's POST body contains webhook information in JSON format.

Each webhook contains the following properties:

Data - Data contains webhook data related to webhook trigger in JSON format

Event - Determine the event associated with the webhook

When your server receives a webhook from Acquire, it should respond with HTTP 200 response. Otherwise, Acquire will retry sending the webhook to your service for 5 more times unless it receives the correct HTTP 200 response.

Note: Acquire webhooks are sent with Content-Type: application/JSON header, so please make sure that your service can handle such requests.

All selected events you get on your web and webhook data method using POST (REQUEST) or data type JSON format.

Example Webhook

{
        "id":58624,
        "message":{
            "type":"message",
            "msg":"Hii",
            "user":{
                "id":15416,
                "type":"agent",
                "name":"Jaisaram",
                "photo":null
            },
        },
        "event":"CHAT_ON_MESSAGE"
    }

Example Integrations

Here are some ideas for using Acquire webhooks:

Read additional information about your visitors from your database and send it back to the Acquire app, display a warning message on your internal status board when your website visitors start queuing before the chat, save each chat transcript in the external system.

PreviousWebhook Integrate StepsNextWebhook Events

Last updated 6 years ago