ZuckZapGo Admin icon

ZuckZapGo Admin

Administrative operations for ZuckZapGo WhatsApp API

Overview

This node provides administrative operations for managing users and global settings in the ZuckZapGo WhatsApp API system. It is useful for automating user lifecycle management, such as creating new users with specific configurations, deleting users either partially or fully, retrieving system-wide statistics and configurations, and testing global event systems.

Practical examples include:

  • Creating a new WhatsApp API user with custom webhook URLs and event subscriptions.
  • Deleting a user from the database or completely removing all their data including storage and sessions.
  • Fetching global system statistics to monitor usage or performance.
  • Sending test events globally to verify event handling pipelines.

Properties

Name Meaning
Operation The action to perform. Options: Create User, Delete User, Delete User Full, Get Global Configuration, Get Global Stats, List Users, Reload Global Config, Send Global Test Event, Test Global Systems
User ID ID of the user to delete (required for Delete User and Delete User Full operations).
User Name Name of the user to create (required for Create User operation).
User Token Authentication token for the user (required for Create User operation).
Additional Options Collection of optional settings when creating a user, including: Webhook URL, Events to subscribe to, Expiration timestamp, various skip flags (media, groups, newsletters, broadcasts, own messages, calls), call rejection message and type, proxy configuration, S3 storage settings, RabbitMQ messaging settings.
Event Type Type of event to send in a global test event (required for Send Global Test Event).
Test User ID User ID used for sending a global test event (required for Send Global Test Event).
Test Data Custom JSON data payload for the global test event.

Output

The node outputs an array of JSON objects representing the response from the ZuckZapGo API for each input item processed. The structure depends on the operation:

  • For user-related operations (create, delete, list), it returns user details or confirmation responses.
  • For global stats or configuration retrieval, it returns the respective data objects.
  • For test events and system tests, it returns status or result information.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the ZuckZapGo Admin API.
  • The node makes HTTP requests to the configured ZuckZapGo API endpoint using the provided admin token.
  • Proper network access to the ZuckZapGo API server is necessary.

Troubleshooting

  • Invalid JSON in Test Data: When sending a global test event, the "Test Data" property must be valid JSON. An error will be thrown if parsing fails. Ensure the JSON syntax is correct.
  • Missing Required Parameters: Operations like Delete User require a valid User ID. Omitting required fields will cause errors.
  • Authentication Errors: If the API key or token is invalid or expired, requests will fail. Verify credentials are correctly configured.
  • Network Issues: Failure to reach the API endpoint due to network problems will cause request errors.
  • Unsupported Operations: Selecting an operation not supported by the current API version may cause failures.

Links and References

Discussion