Skip to main content
WEBHOOK

Headers

X-Wabox-Event
enum<string>
required

Tipo do evento.

Available options:
received
X-Wabox-Event-Id
string
required

Id único do evento (ULID). Use para deduplicar.

X-Wabox-Instance-Id
string
required

Instância que gerou o evento.

X-Wabox-Signature
string

t=<unix seconds>,v1=<hex>v1 = HMAC-SHA256(secret, "<t>.<corpo cru>"). Ausente quando a instância não tem segredo.

Body

application/json
type
enum<string>
required
Available options:
received
event_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
instance_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
momment
integer
required
Required range: 0 <= x <= 9007199254740991
message_id
string
required
Minimum string length: 1
phone
string
required
Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
from_me
boolean
required
from_api
boolean
required
is_group
boolean
required
is_newsletter
boolean
required
is_edit
boolean
required
forwarded
boolean
required
broadcast
boolean
required
waiting_message
boolean
required
status
enum<string>
required
Available options:
PENDING,
SENT,
RECEIVED,
READ,
READ_BY_ME,
PLAYED
chat_lid
string
sender_lid
string
chat_name
string
sender_name
string
sender_photo
string
participant_phone
string
Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
participant_lid
string
reference_message_id
string
Minimum string length: 1
message_expiration_seconds
integer
Required range: -9007199254740991 <= x <= 9007199254740991
expires_at
integer
Required range: 0 <= x <= 9007199254740991
text
object
image
object
audio
object
video
object
document
object
sticker
object
location
object
contact
object
contacts
object[]
reaction
object
poll
object
poll_vote
object
buttons_response
object
list_response
object
buttons
object
list
object
event
object
event_response
object
newsletter_invite
object
product
object
order
object
notification
enum<string>
Available options:
REVOKE,
GROUP_CREATE,
GROUP_CHANGE_SUBJECT,
GROUP_CHANGE_DESCRIPTION,
GROUP_CHANGE_ICON,
GROUP_PARTICIPANT_ADD,
GROUP_PARTICIPANT_REMOVE,
GROUP_PARTICIPANT_PROMOTE,
GROUP_PARTICIPANT_DEMOTE,
GROUP_PARTICIPANT_LEAVE,
GROUP_PARTICIPANT_INVITE,
MEMBERSHIP_APPROVAL_REQUEST,
CALL_RECEIVED,
CALL_MISSED,
CALL_MISSED_VOICE,
CALL_MISSED_VIDEO,
E2E_ENCRYPTED,
CIPHERTEXT,
PROFILE_NAME_UPDATED,
PROFILE_PICTURE_UPDATED
notification_parameters
string[]
unsupported
object

Response

2XX

Qualquer 2xx confirma o recebimento. Outros códigos (ou timeout de 10 s) agendam nova tentativa.