Actions4
- Chat Actions
- Stream Actions
Overview
The node interacts with the AnywhereWorks API to retrieve multiple streams associated with a specified account. It is designed to fetch either public or private streams, filter them by their status (active, inactive, or all), and supports pagination through cursors. This node is useful in scenarios where you need to list streams for an account, such as displaying available communication channels or monitoring active/inactive streams within an application.
Practical examples:
- Fetching all active private streams of a user’s account to display in a dashboard.
- Retrieving public streams for browsing or subscription purposes.
- Paginating through large sets of streams when building integrations that sync stream data.
Properties
| Name | Meaning |
|---|---|
| Account ID | The unique identifier of the account whose streams are to be retrieved. |
| Return Public Streams | Boolean flag indicating whether to return public streams (true) or private streams (false). |
| Status | Filter streams by their status: All (no filter), Active, or Inactive. |
| Limit | Maximum number of stream results to return in one request (minimum 1). |
| Cursor | Pagination cursor token used to fetch the next set of results. |
Output
The output contains a JSON array of stream objects retrieved from the AnywhereWorks API. Each object represents a stream with its associated metadata (such as stream ID, name, status, visibility, etc.). If pagination is used, the response may include a cursor for fetching subsequent pages.
No binary data output is indicated for this operation.
Dependencies
- Requires an API authentication token configured via OAuth2 credentials to access the AnywhereWorks API.
- The base URL for API requests is
https://access.anywhereworks.com. - Proper configuration of the credential in n8n is necessary to authenticate requests.
Troubleshooting
- Invalid Account ID: If the provided account ID is incorrect or does not exist, the API will likely return an error or empty result. Verify the account ID before running the node.
- Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the OAuth2 credential is correctly set up and authorized.
- Pagination Issues: Using an invalid or expired cursor may result in errors or no results. Always use the cursor returned from the previous response.
- Rate Limits: The API might enforce rate limits; if exceeded, requests could fail temporarily. Implement retry logic or reduce request frequency.
- Status Filter Misuse: Providing an unsupported status value will likely cause the API to ignore the filter or return an error. Use only the allowed options: All, Active, Inactive.
Links and References
- AnywhereWorks API Documentation (general reference): https://docs.anywhereworks.com/api
- OAuth2 Authentication Guide: https://docs.anywhereworks.com/authentication/oauth2
- n8n Documentation on Credentials: https://docs.n8n.io/credentials/overview/