Webhook
Enhance communication and automation with Gallabox's Webhook feature. Easily set up data and event notifications by configuring the URL, secret token, HTTP headers, & selecting specific events.
Last updated
Enhance communication and automation with Gallabox's Webhook feature. Easily set up data and event notifications by configuring the URL, secret token, HTTP headers, & selecting specific events.
Last updated
Gallabox offers a Webhook feature that allows you to set up real-time integration with external systems or services. This feature enables you to send data and notifications from Gallabox to other platforms, ensuring seamless communication and automation. Here is the key components in Webhook configuration:
Request URL: The Request URL is the endpoint where Gallabox sends data and events. This is typically an external system or service that can receive HTTP requests. You specify the URL of the receiving system here.
Go to Settings in the left navigation panel and select Webhook. Click on + Add new.
Add the Request URL, secret, headers, and select the events.
| Field | Description |
|---|---|
Request URL* | Enter the URL where the webhook notifications will be sent. |
Optionally, enter a secret token for added security. | |
Headers | Optionally, customize HTTP headers for the webhook request. |
Select Events* | Choose from a variety of events for which notifications will be triggered. |
Users can select from the following categories of events:
| Event | Descrition |
|---|---|
Contact.created | Triggered when a new contact is created. |
Contact.updated | Triggered when an existing contact is updated. |
Contact.mapped | Triggered when a contact is mapped to another entity. |
Contact.unmapped | Triggered when a contact is unmapped from an entity. |
| Event | Description |
|---|---|
Conversation.created | Triggered when a new conversation is initiated. |
Conversation.updated | Triggered when an existing conversation is updated. |
Conversation.UnAttended | Triggered whenever autoReply message is being sent. |
Conversation.Tag.mapped | Triggered when a tag is mapped to a conversation. |
Conversation.Tag.unmapped | Triggered when a tag is unmapped from a conversation. |
| Event | Description |
|---|---|
Message.received | Triggered when a new message is received. |
Message.flow.received | Triggered when a message flow is received. |
Message.WA.Cart.received | Triggered when a cart message is received on WhatsApp |
Message.WA.status.received | Triggered when the status of a WhatsApp message is received. |
Message.WA.status.failed | Triggered when a WhatsApp message fails to send. |
Message.WA.Payment.status.received | Triggered when the status of a payment message sent via WhatsApp is received. |
| Event | Description |
|---|---|
Template.status | Triggered when the status of a message template changes. |
Webhook Logs provide detailed information about webhook events, their status, and associated data. Here's what you can find in the Webhook Logs in Gallabox:
| Field | Description |
|---|---|
Webhook Log ID | This is a unique identifier for each webhook log entry, enabling easy reference and tracking of webhook activities. |
Event | The "Event" column specifies the type of event that triggered the webhook. For example, "Conversation Update" or "Message Received." |
Created At | This timestamp indicates when the webhook event occurred, offering a chronological view of webhook activities. |
Status | The "Status" field represents the current state of the webhook event. In this context, "Failed" indicates that the webhook event was not successful. |
Payload | The "Payload" refers to the data associated with the webhook event. It includes the content or information transferred from Gallabox to the external system or service via the webhook. |
Gallabox secures its requests with a unique secret (configured by you) specific to webhooks. Using the webhook secrets, your app can more reliably confirm the authenticity of Gallabox requests.
To verify the requests, follow these steps:
Retrieve the signature: Extract the signature from the x-gallabox-signature header in the incoming HTTP request.
Create a hash: Generate an HMAC SHA-256 hash using your webhook secret and the request payload.
Compare with the signature: Compare the generated hash with the signature from the HTTP header.
If the hash and the signature match, the request is verified as originating from Gallabox and can be processed. If not, the request should be rejected.
For enhanced security, keep the secrets confidential and update regularly.
In WhatsApp Channel, users can verify if the webhook is set up correctly. If issues are detected, a "Fix Channel Issue" button appears. Clicking it will properly configure the webhook for that channel.
