Integration types
In this article, we will explain the difference between Webhooks, APIs, and Client Actions.
Estimated reading time: 10 minutes
Botmaker is a platform that provides numerous integration possibilities and each one has a specific purpose. In this article, we will explain the difference between webhooks, API, and client actions so you know exactly what you need for your use case.
Webhook
What is a webhook?
A webhook is a way to receive information. Through Botmaker's webhook you can send clients messages from chats and user conversations, all in real-time.
How does it work?
Through an added endpoint/webhook, users' conversation histories will be sent. Each customer must provide their webhook to Botmaker through the Channels & Integrations>Webhooks tab. After attaching the webhook and activating it, the system should immediately start sending messages in real-time.
Benefits
This process will make it easier to check chat histories when needed, so you will be able to save time and resources. By receiving this history in real-time, it is possible to store these chats in a proprietary database.
Below you can find an example of the webhook registration screen:
For more information on how to set up a webhook, please refer to our article: How to integrate webhooks?
API
What is an API?
API is an interface available for the extraction and implementation of data, where it is possible to crossover between platforms, perform actions and obtain information from the platform and/or customers who contact you, all through scripts and codes.
How does it work?
All actions/calls that we perform through the API are done through endpoints/methods found in our documentation. You can set up a script/code in your system to act as calling Botmaker endpoints automatically when needed (to get data, perform messaging actions, etc.).
Benefits
The API was created to make life easier and simpler for developers. Using the ready-to-use "endpoints/methods", it is possible to perform the appropriate actions, thus obtaining data with predetermined intervals for backups, analysis, cross-platform crossover, etc… without the need to develop a script from scratch.
Through the Channels & Integrations > Botmaker API tab, it is possible to generate an access token and view our documentation:
To learn more about the Botmaker API and what it offers, please refer to the articles below:
How to access the Botmaker API?
How to access the Botmaker API for WhatsApp?
Client Action
What is a Client Action?
Client Action is a tool available on the platform for client-side code development. Its purpose is to generate customized behaviors within the created flows.
How does it work?
From the code tab, a programmer can develop a code/script for a specific purpose, such as integrating a platform with an open API, verifying data in a database, etc.
Once completed, the Client Action can be included within the bot's intent flow. To do this, simply set up the "Client Action" action within a flow intent, including the requested parameter which is the name of the developed code.
Benefits
Client Action allows system integration for queries, data records, and, with this information, the conversational flow can be customized. It is an advanced automation that provides a better experience to users interacting with the bot and also facilitates the visualization of information and service operation.
The code tab provides a free screen for development with the ability to test scripts, format them and even have a list of code samples:
For more information, please refer to our article about developing code on the platform: How to develop code on the platform?
Written by: Botmaker Team
Updated: 09/15/2021