WebhookWebhook Integration

Webhook Integration Guide


Step 1: Create a Webhook URL

New Webhook

Create an endpoint that handles both GET and POST requests. This will be your webhook URL.

Example webhook URL:

https://0c50ce410a89.ngrok-free.app/api/v1/webhook

Implementation Requirements:

  • Must handle GET and POST methods
  • Must be accessible over HTTPS
  • Must return a 200 OK response for successful requests

Step 2: Select Webhook Events & Enter Secret Key

Follow the steps below:

  1. Enter Webhook URL – Add the URL where you want to receive webhook notifications.
  2. Enter Secret Key – Provide a secret key to securely sign each webhook event.
  3. Select Events – Choose which events you want to receive notifications for:
    • incoming_message – Receive all incoming messages
    • status_update – Receive message delivery status updates
  4. Click Register – Save and register your webhook configuration.
Webhook Events

Step 3: Validate Your Webhook URL

When you save your webhook URL in the dashboard, the system will send a GET request with a challenge parameter for verification.

Before Webhook Validation

Step 4: Handle Incoming Webhook Events

Once verified, your webhook will start receiving POST requests for the subscribed events. Handle these events in your application.

After Webhook Validation

Testing Your Webhook

  1. Save your webhook URL in the dashboard
  2. Send a test message to your WhatsApp number
  3. Verify that you receive the webhook events
  4. Check your logs to ensure proper handling of the events