set webhook

GET/webhook/set/APIKEY

Add an address as a webhook

Our new feature allows you to effortlessly configure your webhook URL. By setting up a webhook, you gain access to comprehensive insights into message activity.

With the webhook integration, you can receive real-time updates on all incoming messages and delivery statuses of outgoing messages. The delivery report provides valuable information, categorizing messages into three statuses:

Delivery Number "1" (Server): Indicates that the message has been successfully sent to the WhatsApp server (indicated by one gray tick).
Delivery Number "2" (Phone): Means that the message has been delivered to the user's WhatsApp phone (indicated by two gray ticks).
Delivery Number "3" (Read): Indicates that the user has read the message (indicated by two blue ticks).

URL should return status 200

Request

Query Params

url

string

required

Your Webhook Address

Example:

https://example.com/webhook

Request samples

Responses

set webhook(200)

HTTP Code: 200

Content Type : JSONapplication/json

status

string

required

url

string

required

apiKey

string

required

message

string

required

{
  "status": "true",
  "url": "https://example.com/webhook",
  "apiKey": "APIKEY",
  "message": "Webhook has been set successfully"
}

Last modified: 5 months ago