Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
The node provides an interface to a universal messaging gateway API, allowing users to perform various operations on identities within a project. Specifically, the Identities - Lookup operation enables looking up an identity by providing a platform configuration ID and a provider-specific user ID. This is useful for retrieving identity information linked to a particular user on a given platform.
Common scenarios include:
- Integrating with multiple messaging platforms and needing to resolve a user’s identity across these platforms.
- Synchronizing user data or metadata based on platform-specific user identifiers.
- Building workflows that require fetching identity details before sending messages or performing other actions.
Example: Given a Telegram user ID and the Telegram platform configuration ID, you can look up the corresponding identity in your system to get unified user information.
Properties
| Name | Meaning |
|---|---|
Platform configuration ID (platformId) |
The unique identifier of the platform configuration where the user exists. Required to specify which platform to query. |
Provider-specific user ID (providerUserId) |
The user ID specific to the platform/provider. Used to identify the user uniquely on that platform. |
Project (project) |
The project identifier under which the lookup operation is performed. Defaults to "default". |
Output
The output JSON contains the identity information retrieved from the messaging gateway API for the specified platform user ID. This typically includes identity metadata such as display name, email, aliases, and other associated data.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests against the messaging gateway API.
- The node uses the base URL and authentication headers from the configured credentials.
- The project identifier must be provided to scope the request correctly.
Troubleshooting
- Missing or invalid
platformIdorproviderUserId: The API will fail to find the identity if these are incorrect or missing. Ensure these values are accurate and correspond to existing platform configurations and user IDs. - Authentication errors: If the API key credential is not set up properly or has insufficient permissions, requests will fail. Verify the API key and its scopes.
- Project not found: Using an incorrect project identifier may result in errors or empty responses. Confirm the project ID is valid.
- Empty or no results: If no identity matches the given platform user ID, the response may be empty or indicate no match. Double-check input parameters.
Links and References
- MsgCore API Documentation (replace with actual URL)
- n8n documentation on HTTP Request Node for understanding how routing and requests work in custom nodes.