GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

This node integrates with the GateKit API to manage projects within the GateKit platform. Specifically, the "Create" operation under the "Projects" resource allows users to create a new project by specifying its name, description, and environment. This is useful for organizing messaging platforms, identities, members, and other resources under distinct projects.

Typical use cases include:

  • Automating the creation of new projects in GateKit as part of onboarding workflows.
  • Programmatically managing multiple projects for different teams or clients.
  • Setting up isolated environments (development, staging, production) for messaging integrations.

Example: Creating a new project named "Marketing Campaign" with a description and setting it to the "production" environment to start integrating messaging platforms for that campaign.

Properties

Name Meaning
Project name The name of the new project to be created.
Project description An optional textual description providing details about the project.
Project environment The environment for the project; options are: development, staging, production. Defaults to development.

Output

The output JSON will contain the response from the GateKit API after creating the project. This typically includes details such as the project ID, name, description, environment, creation timestamps, and other metadata returned by the API.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the GateKit API.
  • The base URL for the API is configured via credentials.
  • The node sends a POST request to /api/v1/projects with query parameters representing the project properties.

Troubleshooting

  • Missing required fields: If the "Project name" is not provided, the API will likely return an error. Ensure all required fields are set.
  • Authentication errors: Invalid or missing API key credentials will cause authentication failures. Verify the API key configuration.
  • API endpoint issues: Network problems or incorrect base URL settings can prevent successful requests.
  • Invalid environment value: Only "development", "staging", or "production" are accepted. Using other values may cause errors.

Links and References

Discussion