Overview

This node interacts with the Z-API service to update webhook settings for events. Specifically, it allows enabling or disabling the webhook and setting the webhook URL to receive event notifications. This is useful in scenarios where you want to control how your application receives real-time updates or notifications from the Z-API service, such as enabling a webhook to listen for incoming messages or disabling it when not needed.

Use Case Examples

1. Enable the webhook to start receiving event notifications at a specified URL.
2. Disable the webhook to stop receiving event notifications temporarily.
3. Update the webhook URL to change where event notifications are sent.

Properties

Output

JSON

• enabled - Indicates if the webhook is enabled or disabled.
• webhookUrl - The URL set to receive webhook event notifications.
• status - The status or result of the webhook update operation.

Dependencies

• Requires an API key credential for authenticating with the Z-API service.

Troubleshooting

• Ensure the webhook URL is a valid and reachable URL; invalid URLs may cause failures.
• If the webhook update fails, check the API key credential and network connectivity.
• Common error messages may include authentication errors or invalid parameter errors; verify credentials and input parameters accordingly.

Links

• Z-API Documentation - Official documentation for the Z-API service, including webhook management.