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 (including database, storage, and logout), and retrieving or modifying global system configurations and statistics.

Practical examples include:

  • Creating a new WhatsApp API user with custom webhook URLs and event subscriptions.
  • Deleting a user completely from all systems when they no longer need access.
  • Fetching global system statistics to monitor usage or performance.
  • Sending test events globally to verify system integrations.

Properties

Name Meaning
User ID ID of the user to delete. Required for "Delete User" and "Delete User Full" operations.

The node also supports other operations (not requested here) with additional properties like:

  • Operation: Selects the action to perform (e.g., createUser, deleteUserFull).
  • User Name: Name of the user to create.
  • User Token: Authentication token for the user.
  • Additional Options: Various optional settings for user creation including webhook URL, event subscriptions, expiration timestamp, media download preferences, proxy, S3 storage, and RabbitMQ configurations.

Output

The output is a JSON array where each item corresponds to the result of an operation performed on an input item. The structure depends on the operation:

  • For deletion (deleteUserFull), the output contains the response from the API confirming the deletion status.
  • For other operations, it returns the relevant data from the API such as user lists, created user details, or global configuration/stats.
  • In case of errors, the output includes an error message object.

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 API endpoint using the provided admin token.
  • No additional external dependencies are required beyond network access to the API.

Troubleshooting

  • Invalid User ID: If the user ID provided does not exist or is malformed, the API may return an error. Verify the user ID format and existence.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • JSON Parsing Error: When sending test events, the "Test Data" must be valid JSON; otherwise, an error will be thrown.
  • Network Issues: Connectivity problems to the API endpoint will cause request failures.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.

Links and References

Discussion