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 integrates with the AvantGuard ClerkChat service, specifically providing functionality to search for chat users via the Public Admin resource. It allows users to query ClerkChat's user database by specifying parameters such as email addresses. This is useful in scenarios where you need to retrieve user information from ClerkChat for administrative or support purposes, such as verifying user identities, managing chat participants, or syncing user data with other systems.
For example, a customer support workflow could use this node to find users by their email addresses before initiating a chat session or updating user records.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional parameters to refine the search query. Currently supports: Emails - an array of user email addresses to search for. |
- Emails: A JSON array of email strings used to filter and find specific users in ClerkChat.
Output
The node outputs JSON data representing the search results of ClerkChat users matching the query parameters. The structure typically includes user details such as identifiers, emails, names, and possibly other metadata returned by the ClerkChat API.
If binary data were involved (not indicated here), it would represent files or media associated with users, but this node focuses on JSON user data.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard ClerkChat API.
- Needs the base URL of the ClerkChat API configured in the node credentials.
- Depends on the
@avantguardllc/n8n-openapi-nodepackage for OpenAPI integration.
Troubleshooting
Common Issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrectly formatted email arrays may result in query errors or no results.
- Network connectivity issues can prevent successful API calls.
Error Messages:
- Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
- Validation errors may occur if the emails parameter is not a valid JSON array; ensure correct formatting.
- Timeout or connection errors suggest network problems; check your internet connection and API endpoint accessibility.
Links and References
- AvantGuard ClerkChat API Documentation (example placeholder link)
- n8n OpenAPI Node Integration Guide