GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions26

Overview

This node allows you to create a new project within the GateKit system, which is a universal messaging gateway designed to send messages across multiple platforms. Creating a project is typically the first step in organizing your messaging workflows, as projects serve as containers for members, platforms, API keys, and messages.

Common scenarios where this node is beneficial include:

  • Setting up a new messaging environment for development, staging, or production.
  • Organizing different messaging campaigns or applications under separate projects.
  • Automating project creation as part of a larger workflow setup.

For example, you might use this node to programmatically create a "Marketing Campaign" project with a description and specify that it runs in the "production" environment.

Properties

Name Meaning
Project name The name of the project to be created. This is a required string input.
Project description An optional description providing details about the project.
Project environment The environment for the project. Options are: development, staging, or production.

Output

The node outputs JSON data representing the newly created project. This typically includes details such as the project's unique identifier (slug), name, description, environment, and other metadata returned by the GateKit API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the GateKit API.
  • The node sends a POST request to the /api/v1/projects endpoint of the GateKit API.
  • The base URL for the API is configured via credentials (apiUrl).
  • Proper network access to the GateKit API endpoint is necessary.

Troubleshooting

  • Missing Required Fields: If the "Project name" is not provided, the node will fail because it is a required property.
  • Authentication Errors: Ensure that the API key credential is correctly configured and has permissions to create projects.
  • API Endpoint Unreachable: Verify network connectivity and that the API URL is correct.
  • Invalid Environment Value: The environment must be one of the allowed options (development, staging, production). Using an unsupported value may cause errors.
  • Unexpected API Response: Check if the GateKit API service is operational and that the request payload matches expected formats.

Links and References

Discussion