Actions50
- Message Actions
- Contact Actions
- Account Actions
- Call Actions
- Chat Actions
- Group Actions
- Instance Actions
- Media Actions
- Session Actions
- User Actions
Overview
This node integrates with the WSAPI WhatsApp API, allowing users to manage and interact with various WhatsApp resources programmatically. Specifically, the Instance - Update Settings operation enables updating configuration settings of a WhatsApp instance. This is useful for customizing how the WhatsApp instance behaves, such as setting its display name, description, webhook endpoints, authentication headers, and choosing between webhook or pull mode for event handling.
Practical examples include:
- Changing the display name and description to reflect a new use case or team.
- Updating the webhook URL and authentication details when migrating to a new server or securing webhook calls.
- Switching from webhook-based event delivery to pull mode if webhooks are not feasible in the environment.
Properties
| Name | Meaning |
|---|---|
| Settings | A collection of instance configuration settings to update. |
| Name | Display name for the WhatsApp instance (e.g., "My WhatsApp"). |
| Description | Descriptive text about the instance's purpose (e.g., "Customer support WhatsApp instance"). |
| Webhook URL | HTTPS endpoint to receive WhatsApp events and messages (e.g., "https://your-domain.com/webhook/whatsapp"). |
| Webhook Auth Header | HTTP header name used for authenticating webhook requests (e.g., "Authorization"). |
| Webhook Auth Value | Authentication value sent with webhook requests (e.g., "Bearer your-secret-token"). |
| Pull Mode | Boolean flag to enable pull mode, which fetches events instead of receiving them via webhooks. |
Output
The node outputs JSON data representing the result of the update operation on the WhatsApp instance settings. The structure typically includes confirmation of updated fields or error information if the update failed.
If binary data were involved (not indicated here), it would represent media or files related to the instance, but this operation focuses solely on JSON configuration data.
Dependencies
- Requires an API key credential for authenticating with the WSAPI WhatsApp API.
- The base URL for the API must be configured in the node credentials.
- The node depends on the WSAPI service being accessible and properly configured to accept updates to instance settings.
Troubleshooting
Common Issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect webhook URLs or unreachable endpoints may cause webhook delivery issues.
- Providing invalid values or malformed JSON in the settings collection can lead to API errors.
- Enabling pull mode without proper setup might result in no events being received.
Error Messages:
"The resource "instance" is not known!"— indicates a misconfiguration or unsupported resource selection."The operation "updateSettings" is not implemented yet!"— suggests the operation is not available in the current node version.- API errors returned from WSAPI will be passed through; check the message for details like invalid parameters or authorization failures.
Resolutions:
- Verify API credentials and base URL.
- Ensure webhook URLs are HTTPS and publicly accessible.
- Double-check all input fields for correct formatting.
- Consult WSAPI documentation for valid parameter values and required permissions.
Links and References
- WSAPI WhatsApp API Documentation (replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- WhatsApp Business API Webhooks Guide