Connect your system with the WhatsApp chat bot using API

Learn how to integrate external APIs with ease using the API Call feature. Configure HTTP methods, URLs, headers, authentication, and more with detailed instructions.

Overview

The API Call feature facilitates the integration of external APIs into the system by allowing users to make HTTP requests to specified URLs.

What is API?

API stands for Application Programming Interface. It is a set of rules and protocols that allows different software applications to communicate with each other. API acts as a bridge between different software programs, enabling them to exchange data and functionalities easily.

API methods in Gallabox

API methods are requests dictating actions like retrieving, submitting, updating, or removing data between applications. Below are the API methods you can use in Gallabox bot:

GET

Use this method to retrieve information or data from a specified resource.

POST

Use this method to submit data to a specified resource.

PATCH

Use this method to partially update a specified resource.

PUT

Use this method to update a specified resource with new data.

DELETE

Use this method to delete a specified resource.

Key Components of API Call Connector

The API Call Connector in Gallabox has several components that allow for efficient interaction with external APIs. Below are the key components and their descriptions:

Field Name Description

HTTP Method

Choose the HTTP method to be used for the API call, such as GET, POST, PUT, PATCH or DELETE.

URL

The endpoint URL to which the API call will be made.

Headers

Additional information included in the request headers, such as content type, authorization, or custom headers.

Authentication

Select the application from Hubspot, Zoho CRM, Zoho Bigin, Razorpay, and Zoom.

Select Connection

Allows users to choose from pre-configured connections or set up new connections to external systems.

Query Parameters

Optional parameters included in the API call URL to customize the request.

Body Content Type

Specifies the format of the request body content, such as JSON, XML, or form-URL encoded.

Body

The payload or data to be sent in the request body, if applicable.

Test Values

Allows users to input test values for the API call to simulate and validate the request.

Response from API

Displays the response received from the API after making the request, including status code, headers, and body content.

Store Response in Variables

Provides the option to store specific values from the API response or the entire API response in variables to use in subsequent cards.

Usage

  1. Configure API Call: Input the necessary details such as HTTP method, URL, headers, authentication, and other parameters.

  2. Test API Call: Use test values to simulate the API call and verify the response received from the API.

  3. Store Response Data: Select specific data elements from the API response or the entire API Response to store in variables for use in subsequent cards like Send Products.

The API Call feature offers users a powerful tool for integrating external APIs seamlessly into the system. By following the guidelines provided, users can configure and execute API calls effectively, retrieve relevant data, and leverage it for various system functionalities.

Last updated