SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API
Join our community

Actions148

Overview

This node allows you to create a new communication channel associated with a WhatsApp number using the SparkBot WhatsApp API. Channels can be used to organize conversations, manage messaging flows, or represent different topics or teams within your WhatsApp integration.

Common scenarios where this node is beneficial include:

  • Setting up dedicated channels for customer support, sales, or marketing communications.
  • Organizing WhatsApp interactions by topic or department.
  • Creating channels dynamically as part of an automated workflow to segment incoming messages.

For example, you might use this node to create a "Support" channel linked to a specific WhatsApp number and upload a custom profile image representing that channel.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number to which the channel will be linked.
Channel Name The name of the channel being created.
Description Optional description of the channel (up to 2048 characters).
Upload Image Boolean flag indicating whether to upload a profile image for the channel.
Image Source If uploading an image, specifies the source type: either a URL or Base64-encoded image data.
Image URL When Image Source is URL, the URL of the JPG or PNG image to use as the channel's profile picture. Maximum size 1MB.
Image Data (Base64) When Image Source is Base64, the base64-encoded JPG or PNG image data to use as the channel's profile picture. Maximum size 1MB.

Output

The node outputs JSON data representing the newly created channel. This typically includes details such as the channel ID, name, description, linked WhatsApp number, and any metadata returned by the SparkBot API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the SparkBot API service being accessible and properly configured.
  • The WhatsApp number ID must be valid and associated with your SparkBot account.
  • If uploading an image, the image must be in JPG or PNG format and not exceed 1MB in size.

Troubleshooting

  • Invalid WhatsApp Number ID: Ensure the WhatsApp number ID provided exists and is linked to your account.
  • Image Upload Failures: Verify the image format (JPG or PNG) and size (max 1MB). For URL images, ensure the URL is accessible and points directly to the image file.
  • API Authentication Errors: Confirm that the API key credential is correctly set up and has necessary permissions.
  • Description Length Exceeded: Keep the channel description under 2048 characters to avoid validation errors.
  • Network Issues: Check connectivity to the SparkBot API endpoint if requests time out or fail.

If the node throws an error, it usually contains a message describing the issue. Enabling "Continue On Fail" allows workflows to proceed even if channel creation fails, returning the error message in the output JSON.

Links and References

Discussion