A Simple Guide to Understanding & Using Maxchat’s Integration Features: Automation and Instant Notifications

Maxchat isn’t just a platform for replying to chats manually. It also offers advanced features you can integrate with your existing systems. The two primary features for this are REST API and Webhook.

This article explains both features in an easy-to-understand way, focusing on what you can do with them and the basic setup steps in Maxchat. Keep in mind, to use the results of these settings (such as sending messages via API or receiving Webhook data), you may need help from a technical team. However, understanding the concepts and the setup within Maxchat itself is straightforward.

Let’s dive in, one by one.

Using the REST API: Send Automated Messages from Your System

Imagine you want your system (for example, a sales or registration system) to automatically send messages to customers via Maxchat WhatsApp, such as order notifications or OTP codes. This is where the REST API comes in.

A REST API is a way for one application (your system) to “talk” to another application (Maxchat) using standard commands over the internet.

Key API Concepts You Should Know:

• Token (Authorization Key): This is your “digital key.” Every time your system wants to “talk” to Maxchat via the API, it must present this key as proof that you’re authorized. The token is critical for security.
• Base URL & Message-Send URL: These are the internet addresses where your system sends its requests. There’s Maxchat’s base address (https://app.maxchat.id) and a specific endpoint for sending messages (https://app.maxchat.id/api/messages/push).
• Method (POST): This is the type of “command” you send. To send a message, you use the POST method, which means you’re “sending new data” to Maxchat.
• Body: This is the “data package” containing the details of the message you want to send. It includes the destination number, message type (text, image, video), the template ID if you’re using an approved template, and values to fill the template’s placeholders (such as an OTP code).

How to Obtain a Token in Maxchat:

The only thing you need to do on the Maxchat dashboard to use the API (based on the source) is obtain your Token.

1. Go to the Integration menu.
2. Select the App Service sub-menu.
3. Choose Rest API.
4. You will see a Generate Token button. Click it to create your new token.
5. Copy the token that appears. This token is confidential and will be used by your technical team.

How to Use the API (for Your Technical Team):

Your technical team will use the Token, URL, Method, and Body to create requests from their system. They can use tools like Postman or Swagger.

• They will send a POST request to https://app.maxchat.id/api/messages/push.
• In that request, they will include your Token in the “Auth” or “Authorization” section, typically using the format “Bearer [Your Token]”.
• They will construct the request Body with the message data (destination number, template ID, etc.) according to the required format.
• If successful, Maxchat will return a success response. If there is an error (for example, an invalid Token), Maxchat will return an error message. If it fails due to the Token, try generating a new Token in Maxchat.

In short: Maxchat provides the “door” (API) and the “key” (Token). Your technical team uses the “key” to open the “door” and “send a data package” (Body) containing the message to Maxchat.

Using Webhooks: Receive Real-Time Notifications in Your System

Unlike the API above (where you “pull” or “request” data from Maxchat), Webhooks let Maxchat “push” or “send” data to your system automatically as soon as certain events occur. This is extremely useful for real-time integrations.

Imagine you want your CRM to immediately know whenever there’s a new incoming message from a customer in Maxchat, or whenever the status of a message you sent changes to “read.” Webhooks make this possible.

Key Webhook Concepts You Should Know:

• Trigger Event: These are the events in Maxchat that trigger notifications. Examples include: a new incoming message, an outgoing message, a change in message status (sent, delivered to device, read), or a chat being marked as resolved.
• Webhook URL: This is the internet address in your system where Maxchat will send data when a trigger event occurs. Your system must have this address and be ready to receive data.
• Payload: This is the actual data that Maxchat sends to your Webhook URL when the event occurs. It’s usually JSON and includes detailed information about the event (who sent it, message content, timestamp, etc.).

How Webhooks Work (Simple):

1. You choose the events in Maxchat that you want to monitor (for example, “Incoming Message”).
2. Your technical team creates a Webhook URL in your system that can receive data. (There are third-party sites like webhook.site you can use to test receiving data.)
3. You configure Maxchat to “send data to URL Y when event X occurs.”
4. When event X happens in Maxchat, Maxchat automatically sends the data (Payload) to URL Y.
5. Your system at URL Y receives the data and processes it as needed (for example, saving a new message to the CRM database).

Webhook Setup Steps in Maxchat:

Setup in Maxchat is simple. You only need to enter the URL prepared by your technical team:

1. Go to the Integration menu.
2. Select the App Services sub-menu.
3. Choose Webhook.
4. In the provided text area, enter the Webhook URL your technical team created.
5. You can add more than one URL if needed (Maxchat supports up to 5 different URLs for each event type).
6. Maxchat will automatically send data for the events you select (you can customize which events are sent to each URL, though the source does not detail per-event-per-URL settings and mentions “linking events to multiple different URLs”).

Events Available in Maxchat:

Maxchat can send notifications for several important event types:

• Incoming Message: When a new message from a customer arrives at your business number.
• Outgoing Message: When you send a message from Maxchat to a customer.
• Message Status: When the status of a sent message changes (Sent to server, Delivered to the customer’s device, or Read).
• Resolved: When a conversation is marked as resolved.
• Login/Logout Activity: When a user (Admin, Agent, etc.) logs in or logs out of their Maxchat account.

Whenever any of these events occur, Maxchat sends a “data package” (Payload) containing specific details about the event to the URL you’ve set.

In short: Webhooks are how Maxchat automatically and instantly notifies your system about what’s happening on the platform, as long as you’ve set up a receiving “address” (Webhook URL) in your system.

Conclusion:

Maxchat’s REST API and Webhook features are powerful tools for integrating Maxchat with your other business systems, enabling automated message sending and real-time activity monitoring.

While the technical implementation (using the API in your code or receiving and processing Webhook data) requires programming expertise, the basic setup in the Maxchat dashboard to obtain an API Token or enter a Webhook URL is simple and can be done once you understand the core concepts.

If you require further assistance, please contact the Maxchat support team via WhatsApp.

Need other guides?Visit the Maxchat documentation for comprehensive information on features and usage.