GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

The node provides integration with the GateKit universal messaging gateway API, allowing users to manage identities within projects. Specifically, the "Get" operation under the "Identities" resource retrieves detailed information about a specific identity by its ID within a given project.

This node is beneficial in scenarios where you need to fetch and use identity details for messaging, user management, or analytics purposes across multiple platforms linked via GateKit. For example, you might want to retrieve an identity's metadata before sending targeted messages or updating user profiles.

Properties

Name Meaning
Identity ID The unique identifier of the identity to retrieve.
Project The project identifier within which the identity exists.
Id Alias for the identity ID parameter (used interchangeably with "Identity ID").

Output

The output JSON contains the detailed data of the requested identity as returned by the GateKit API. This typically includes fields such as the identity's display name, email, metadata, platform aliases, and other relevant attributes associated with that identity.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the GateKit API.
  • The node expects the base URL for the API to be configured in the credentials.
  • Proper project identification is necessary to scope the request correctly.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Identity ID will result in an error from the API indicating the identity was not found.
    • Incorrect or missing project identifiers may cause authorization or resource not found errors.
    • Missing or invalid API authentication credentials will prevent successful API calls.
  • Error messages and resolutions:

    • "Identity not found": Verify the Identity ID and Project parameters are correct.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is valid and properly configured.
    • "Bad Request": Ensure all required parameters are provided and correctly formatted.

Links and References

Discussion