Actions33
- Public Actions
- Public Admin Actions
- Reseller Actions
- Create New Team
- Get Team Information
- Update Team
- Remove Team From Reseller
- Update Team Avatar
- Create Team Bulk Inboxes And Users
- Get Team Users
- Add User To Team
- Remove Users From Team
- Get Team Inboxes
- Remove Team Inboxes
- Create Team Bulk Inboxes
- Assign Users To Inbox
- Remove Users From Inbox
- Get Team Whitelist Domains
- Create Team Whitelisted Domain
- Remove Team Whitelisted Domain
- Create Reseller
- Import Team Users
- Get Import Team Users Job Status
Overview
This node operation, "Find Messages For Active Team" under the "Public" resource, is designed to retrieve messages associated with an active team. It allows users to query messages filtered by various optional parameters such as inbox IDs, date ranges, pagination, and limits on the number of results. This functionality is useful in scenarios where a user needs to programmatically access team communication data for analysis, reporting, or integration with other systems.
Practical examples include:
- Fetching recent messages from specific inboxes within a certain date range.
- Paginating through large sets of messages to process them in batches.
- Limiting the number of messages retrieved to optimize performance or meet API constraints.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional filters and controls for the message retrieval: |
| - Inbox Ids | The IDs of the inboxes to filter messages by. If not provided, all inboxes will be included. |
| - Start | Only messages after this date (ISO 8601 string) until the end date or now. |
| - End | Only messages up to this date (ISO 8601 string). |
| - Limit | Number of items to return (maximum 50). |
| - Page | Page number for paginated results. |
Output
The output of this node operation is a JSON array containing message objects that match the specified query parameters. Each message object typically includes details such as message content, sender information, timestamps, and related metadata relevant to the team’s communication.
If the node supports binary data output (not explicitly shown in the provided code), it would represent attachments or media associated with messages; however, based on the static analysis, the primary output is structured JSON data representing messages.
Dependencies
- Requires an API key credential for authentication to the external AvantGuard ClerkChat service.
- Depends on the "@avantguardllc/n8n-openapi-node" package for building request properties and handling API interactions.
- Needs configuration of the base URL for the API endpoint via credentials.
Troubleshooting
Common Issues:
- Providing invalid or expired API credentials will result in authentication errors.
- Exceeding the maximum limit of 50 items per request may cause the API to reject the query.
- Incorrect date formats for
startandendparameters can lead to query failures or empty results. - Pagination parameters (
page) must be non-negative integers; invalid values might cause unexpected behavior.
Error Messages:
- Authentication errors typically indicate missing or incorrect API keys; verify credentials setup.
- Validation errors on query parameters suggest checking the format and allowed values, especially for dates and numeric fields.
- Network or connectivity issues may manifest as timeouts or unreachable host errors; ensure network access to the API endpoint.
Links and References
- AvantGuard ClerkChat API Documentation (hypothetical link based on context)
- n8n Documentation on Creating Custom Nodes
- OpenAPI Specification