SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

The node integrates with the SparkBot WhatsApp API to manage campaigns among other resources. Specifically, the "Get Campaign" operation retrieves detailed information about a particular campaign by its ID. This is useful for users who want to fetch and analyze campaign data such as status, performance, or metadata within their automation workflows.

Practical examples include:

  • Automatically retrieving campaign details to update dashboards.
  • Using campaign data to trigger follow-up actions based on campaign status.
  • Integrating campaign insights into CRM or marketing platforms.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to retrieve. This is required to specify which campaign's details to fetch.

Output

The node outputs JSON data representing the campaign details retrieved from the SparkBot WhatsApp API. The exact structure depends on the API response but typically includes fields such as campaign name, ID, status, creation date, and other relevant metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the external SparkBot WhatsApp API service to fetch campaign data.
  • Proper configuration of the API key credential in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID will cause the operation to fail.
    • Incorrect or expired API key credentials will result in authentication errors.
    • Network connectivity problems can prevent access to the SparkBot API.
  • Error messages and resolutions:

    • "Campaign not found": Verify that the Campaign ID is correct and exists.
    • "Authentication failed": Check that the API key credential is valid and properly configured.
    • "Network error" or timeouts: Ensure stable internet connection and that the SparkBot API endpoint is reachable.

Links and References

Discussion