Skip to main content

Define the events to be monitored

PUT 
/webhook/events

Automatic paths​

The parameter "autoPath" is optional. If not informed or assigned a value equal to false. All events will fire to the default url path.

With the parameter "autoPath=true", automatic paths will be inserted in the url.

The paths will be generated as follows:

chats.set                => /api/chats
chats.update             => /api/chats
chats.delete             => /api/chats

contacts.update          => /api/contacts
contacts.upsert          => /api/contacts

status.broadcast         => /api/status-broadcast

new.message              => /api/new-message
send.message             => /api/new-message

send.message:START       => /api/send-message-queue
seed.message:PROCESSING  => /api/send-message-queue
send.message:COMPLETED   => /api/send-message-queue
send.message:ERROR       => /api/send-message-queue

paused.queue             => /api/queue-manager
resumed.queue            => /api/queue-manager
deleted.queue            => /api/queue-manager

messages.delete          => /api/messages-delete
messages.update          => /api/messages-update
messages.set             => /api/messages-set

presence.update          => /api/presence-update

request.payment          => /api/payment
send.payment             => /api/payment
decline.payment          => /api/payment
cancel.payment           => /api/payment

general.error            => /api/general-error

The other events that cannot be disabled will be mapped as follows:

connection.update        => /api/connection-update
qrcode.updated           => /api/qrcode-updated
reject.call              => /api/reject-call

Request​

Query Parameters

    autoPath string

    Possible values: [true, false]

Body

required
    chatsSet booleanrequired

    Default value: true

    chatsUpdate booleanrequired

    Default value: false

    chatsDelete booleanrequired

    Default value: false

    contactsUpsert booleanrequired

    Default value: true

    contactsUpdate booleanrequired

    Default value: false

    statusBroadcast booleanrequired

    Default value: false

    newMessage booleanrequired

    Default value: true

    sendMessage booleanrequired

    Default value: true

    sendMessageStart booleanrequired

    Default value: true

    sendMessageProcessing booleanrequired

    Default value: true

    sendMessageCompleted booleanrequired

    Default value: true

    sendMessageError booleanrequired

    Default value: true

    groupParticipantUpdate booleanrequired

    Default value: true

    groupUpsert booleanrequired

    Default value: false

    groupUpdate booleanrequired

    Default value: false

    pausedQueue booleanrequired

    Default value: true

    resumedQueue booleanrequired

    Default value: true

    deletedQueue booleanrequired

    Default value: true

    messageDelete booleanrequired

    Default value: false

    messagesUpdate booleanrequired

    Default value: true

    messagesSet booleanrequired

    Default value: false

    presenceUpdate booleanrequired

    Default value: false

    requestPayment booleanrequired

    Default value: false

    sendPayment booleanrequired

    Default value: false

    declinePayment booleanrequired

    Default value: false

    cancelPayment booleanrequired

    Default value: false

    generalError booleanrequired

    Default value: true

Responses​

Loading...