Receive notification

GET

/waInstance{{idInstance}}/receiveNotification/{{apiTokenInstance}}

Documentation ReceiveNotification

Request

Query Params

receiveTimeout

string

required

Notification waiting timeout, takes a value from 5 to 60 seconds

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET '/waInstance{{idInstance}}/receiveNotification/{{apiTokenInstance}}?receiveTimeout=5'

Responses

🟢200receiveNotification

application/json

Body

receiptId

integer

required

body

object

required

typeWebhook

string

required

instanceData

object

required

timestamp

integer

required

idMessage

string

required

senderData

object

required

messageData

object

required

Example

{
    "receiptId": 1234567,
    "body": {
        "typeWebhook": "incomingMessageReceived",
        "instanceData": {
            "idInstance": 1234,
            "wid": "11001234567@c.us",
            "typeInstance": "whatsapp"
        },
        "timestamp": 1588091580,
        "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
        "senderData": {
            "chatId": "79001234568@c.us",
            "sender": "79001234568@c.us",
            "senderName": "Green API"
        },
        "messageData": {
            "typeMessage": "textMessage",
            "textMessageData": {
                "textMessage": "I use Green-API to send this message to you!"
            }
        }
    }
}

Modified at 2025-06-05 06:21:33

Send interactive buttons

Delete notification