Webhooks

Set Webhook URL

Creates a new webhook URL on an instance or updates an existing one, with a precise list of events to subscribe to. (Paid users only)

POST
https://api.wawp.net/v2/webhook/set?access_token=YOUR_ACCESS_TOKEN&events=%5B%22message%22%2C+%22message.ack%22%2C+%22message.edited%22%5D&hmac=my-webhook-secret&instance_id=Your_Instance_ID&is_active=1&name=Production+CRM&retries=%7B%22delay%22%3A+2%2C+%22attempts%22%3A+15%7D&url=https%3A%2F%2Fmy-app.com%2Fwebhook

Authentication Required

Login to swap the placeholders with your real Instance ID and Access Token.

Log In
Test /v2/webhook/set endpoint
POST
POST

No query parameters required

This endpoint doesn't expect data in the URL.

Best practices

  • Only subscribe to events your application actually needs to reduce bandwidth and processing.

  • Always respond with HTTP 200 from your webhook endpoint before processing the event asynchronously.

  • Use a unique secret in the URL query string or hmac field to verify requests come from Wawp.

Set Webhook URL: /v2/webhook/set

The /v2/webhook/set endpoint lets you register a single webhook URL on a WhatsApp instance and choose exactly which events it should receive. If the URL already exists, it is updated in place; otherwise it is appended to the instance's webhook list.

[!IMPORTANT] This endpoint is only available for paid subscription accounts (Unlimited tiers). Free tier users will receive a 403 Forbidden error with code subscription_required.

🎯 When to Use This Endpoint

Use this endpoint when you want to:

  • Connect a new backend URL to receive real-time WhatsApp events.
  • Replace or refresh an existing webhook without touching other configured webhooks.
  • Selectively subscribe to specific event categories to reduce server load.

📦 Request Body

  • url (required): A publicly reachable HTTPS endpoint that accepts POST requests.
  • events (required): An array of event names the webhook should receive.
  • is_active (optional): 1 to enable or 0 to disable the webhook. Defaults to 1.
  • retries (optional): Retry policy object with delay (seconds) and attempts (count). Defaults to { delay: 2, attempts: 15 }.
  • hmac (optional): A secret string added to the X-Wawp-Signature header for basic verification.

🚀 Available Events

These events match the options available in the Wawp Dashboard:

CategoryEvents
Messagesmessage, message.any, message.ack, message.ack.group, message.waiting, message.revoked, message.edited, message.reaction, poll.vote, poll.vote.failed
Groupsgroup.join, group.leave, group.v2.join, group.v2.leave, group.v2.update, group.v2.participants
Session & Callssession.status, state.change, presence.update, chat.archive, call.received, call.accepted, call.rejected
Labelslabel.upsert, label.deleted, label.chat.added, label.chat.deleted
Advancedevent.response

� Request Samples

cURL

curl -X POST "https://api.wawp.net/v2/webhook/set"   -H "Content-Type: application/json"   -d '{
    "access_token": "YOUR_ACCESS_TOKEN",
    "instance_id": "Your_Instance_ID",
    "url": "https://my-app.com/webhook",
    "name": "Production CRM",
    "events": ["message", "message.ack", "message.edited"],
    "is_active": 1,
    "retries": { "delay": 2, "attempts": 15 }
  }'

JavaScript (Fetch)

const res = await fetch('https://api.wawp.net/v2/webhook/set', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    access_token: 'YOUR_ACCESS_TOKEN',
    instance_id: 'Your_Instance_ID',
    url: 'https://my-app.com/webhook',
    events: ['message', 'message.ack', 'message.edited'],
    is_active: 1,
    retries: { delay: 2, attempts: 15 }
  })
});
const data = await res.json();
console.log(data);

�� System Webhook Note

If the url you provide matches the instance's system webhook (https://app.wawp.net/api/webhook/{token}), the event filter is also synced to the Wawp database so the dashboard and inbox reflect the same configuration.

Request Parameters

Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.

Request Body

Sent as a JSON object
string

The 12-character ID of the instance

Example:
string

Your API Access Token

Example:
string

The HTTPS endpoint that will receive webhook events

Example:
array

List of event names to subscribe to

Example:
string—

An optional display name for this webhook (e.g., 'Production CRM', 'Staging Bot')

Example:
number—

1 to enable the webhook, 0 to disable. Default is 1.

Example:
object—

Retry policy: delay in seconds and number of attempts

Example:
string—

Optional secret used for HMAC signature verification

Example:

Request Samples

Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.

1const baseUrl = "https://api.wawp.net";
2const endpoint = "/v2/webhook/set";
3const params = new URLSearchParams({
4  "instance_id": "Your_Instance_ID",
5  "access_token": "YOUR_ACCESS_TOKEN"
6}).toString();
7const body = {
8  "url": "https://my-app.com/webhook",
9  "name": "Production CRM",
10  "events": [
11    "message",
12    "message.ack",
13    "message.edited"
14  ],
15  "is_active": "1",
16  "retries": {
17    "delay": 2,
18    "attempts": 15
19  },
20  "hmac": "my-webhook-secret"
21};
22
23fetch(`${baseUrl}${endpoint}${params ? '?' + params : ''}`, {
24  method: "POST",
25  headers: { "Content-Type": "application/json" },
26  body: JSON.stringify(body)
27})
28  .then(async (response) => {
29    if (response.ok) {
30      const data = await response.json();
31      console.log("Success:", data);
32      return data;
33    }
34    
35    // Error Handling
36    if (response.status === 400) {
37      console.error("Error 400: Bad Request - Missing Required Parameter(s)");
38    }
39    if (response.status === 400) {
40      console.error("Error 400: Bad Request (XML Format)");
41    }
42    if (response.status === 400) {
43      console.error("Error 400: Bad Request (Plain Text)");
44    }
45    if (response.status === 401) {
46      console.error("Error 401: Unauthorized - Invalid or Missing Access Token");
47    }
48    if (response.status === 401) {
49      console.error("Error 401: Unauthorized (XML Format)");
50    }
51    if (response.status === 404) {
52      console.error("Error 404: Not Found - Session Does Not Exist");
53    }
54    if (response.status === 404) {
55      console.error("Error 404: Not Found (XML Format)");
56    }
57    if (response.status === 500) {
58      console.error("Error 500: Internal Server Error - Unexpected Failure");
59    }
60    if (response.status === 500) {
61      console.error("Error 500: Internal Server Error (HTML)");
62    }
63    if (response.status === 502) {
64      console.error("Error 502: Bad Gateway - Connection Failed to Upstream");
65    }
66    if (response.status === 502) {
67      console.error("Error 502: Bad Gateway (XML Format)");
68    }
69
70    const errorText = await response.text();
71    console.error(`Error ${response.status}: ${errorText}`);
72  })
73  .catch((error) => console.error("Network Error:", error));
Interactive Samples
Ln 73, Col 1javascript

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Success - Webhook Set or Updated
Type:
application/json
string *
string *
object *

Example

{
"status": "success",
"message": "Webhook set successfully.",
"webhook": {
  "url": "https://my-app.com/webhook",
  "events": {
    "0": "message",
    "1": "message.ack",
    "2": "message.edited"
    },
  "is_active": 1,
  "enabled": true,
  "retries": {
    "delay": 2,
    "attempts": 15
    }
  }
}
Bad Request - Missing Required Parameter(s)
Unauthorized - Invalid or Missing Access Token
Not Found - Session Does Not Exist
Internal Server Error - Unexpected Failure
Bad Gateway - Connection Failed to Upstream
Previous TopicWebhooks Overview
Next TopicUpdate Webhook

Command Palette

Search for a command to run...