WaAPI icon

WaAPI

Interact with WaAPI API

Actions83

Overview

This node operation allows subscribing to a specific channel by its identifier. It is useful in scenarios where you want to programmatically subscribe an instance or user to a communication channel, such as newsletters or notification streams. For example, you might use this node to add a user to a newsletter channel automatically when they sign up on your platform.

Properties

Name Meaning
Id The instance ID representing the subscriber or entity that will be subscribed. Required.
Channel Id The identifier of the channel to subscribe to. Typically formatted like <channelId>@newsletter.

Output

The output contains JSON data reflecting the result of the subscription request. This typically includes confirmation details about the subscription status or any relevant metadata returned by the API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authentication with the external WaAPI service.
  • The node communicates with the WaAPI API endpoint at https://waapi.app/api/v1.
  • Proper configuration of the API key credential within n8n is necessary for successful requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential can cause authentication failures.
    • Providing an incorrect or malformed Channel Id may result in errors or failed subscriptions.
    • Missing required property "Id" will prevent the operation from executing.

  • Error messages and resolutions:

    • Authentication errors: Verify that the API key credential is correctly set up and has proper permissions.
    • Validation errors related to Channel Id or Id: Ensure these fields are correctly filled and conform to expected formats.
    • Network or connectivity errors: Check internet connection and API endpoint availability.

Links and References

Discussion