GateKit

Universal messaging gateway - send messages across multiple platforms

Actions51

Platforms Actions
Projects Actions
Webhooks Actions
ApiKeys Actions
Auth Actions
Identities Actions
Members Actions
Messages Actions
- List
- Stats
- Sent
- Get
- Cleanup
- Send
- Status
- Retry
- React
- Unreact
Platform Logs Actions
- Logs

Overview

This node allows you to create a new identity within a specified project in the GateKit system. An identity represents a user or entity with associated platform aliases, which link the identity to various messaging platforms. This operation is useful when you want to register a new user or entity that can be recognized across multiple communication platforms managed by GateKit.

Common scenarios include:

Registering a new user with their email and display name along with their platform-specific identifiers.
Creating identities for bots or services that interact on multiple platforms.
Managing user profiles centrally while linking them to different messaging platforms.

Example: You might use this node to create an identity for a customer who interacts via Telegram and WhatsApp by providing their aliases on these platforms, along with optional metadata like email and display name.

Properties

Name	Meaning
Display name for the identity	Optional human-readable name for the identity (e.g., "John Doe")
Email address for the identity	Optional email address associated with the identity
JSON metadata for the identity	Optional JSON string containing additional metadata about the identity
JSON array of platform aliases	Required JSON string representing an array of platform alias objects linked to the identity
Project	Required identifier of the project under which the identity will be created (default is "default")

Output

The output of this node is the JSON response from the GateKit API after creating the identity. It typically includes details of the newly created identity such as its unique ID, display name, email, metadata, and the list of platform aliases associated with it.

If the API supports binary data for this operation, it is not indicated in the provided source; thus, the output is expected to be purely JSON.

Dependencies

Requires an active connection to the GateKit API.
Requires an API key credential configured in n8n to authenticate requests.
The node uses the project identifier to scope the creation of the identity.

Troubleshooting

Invalid JSON in aliases or metadata: Since aliases and metadata are expected as JSON strings, ensure they are correctly formatted JSON. Invalid JSON will cause API errors.
Missing required fields: The aliases property and project are mandatory. Omitting these will result in request failures.
Authentication errors: Ensure the API key credential is valid and has permissions to create identities in the specified project.
API URL configuration: The base URL for the API must be correctly set in the credentials; otherwise, requests will fail.

Links and References

GateKit API Documentation (generic reference, replace with actual if available)
n8n documentation on HTTP Request Node for understanding how API calls are made
JSON formatting guides for preparing aliases and metadata inputs