PAPI WhatsAppInstall

Summary

Set the webhook configuration for a specified WhatsApp instance by providing its ID, webhook URL, activation status, and the events to subscribe to.

Inputs

• ID da Instância (required) — ID da instância WhatsApp to configure the webhook for.
• URL do Webhook (required) — URL where webhook events will be sent.
• Webhook Ativo — Boolean to enable or disable the webhook.
• Eventos — List of events to subscribe the webhook to, such as messages, message status, reactions, presence, group updates, and others.

Output shape

a JSON object containing the response from the API confirming the webhook configuration status or error message.

The output will contain the API response after setting the webhook, including success confirmation or details of any errors. No pagination applies.

Examples

Example 1: Configure a webhook to receive new messages and message status events for a WhatsApp instance

Set 'instanceId' to the target instance, 'webhookUrl' to your receiving endpoint, enable the webhook, and select 'messages' and 'message_status' events.