GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions51

Overview

The "Invite" operation under the "Members" resource allows you to invite a user to join a specific project by sending an invitation to their email address. This is useful in scenarios where you want to add collaborators or team members to your project, granting them access and permissions to work within that project environment.

Practical examples include:

  • Inviting a new developer or team member to collaborate on a software project.
  • Adding a client or stakeholder to monitor project progress.
  • Onboarding users who need access to project resources or messaging platforms managed via the system.

Properties

Name Meaning
email Email address of the user to invite. The invitation will be sent to this email.
project Project identifier to operate on. Specifies which project the user is invited to join.

Output

The node outputs JSON data representing the response from the API after attempting to send the invitation. This typically includes details about the invitation status or any errors encountered. There is no binary data output for this operation.

Dependencies

  • Requires an API key credential for authentication with the GateKit API.
  • The node makes HTTP POST requests to the endpoint /api/v1/projects/{project}/members/invite.
  • The project parameter must correspond to an existing project identifier in the system.
  • Proper network connectivity to the GateKit API service is required.

Troubleshooting

  • Invalid or missing email: Ensure the email address provided is valid and not empty; otherwise, the API may reject the request.
  • Project not found: Verify that the specified project identifier exists and is accessible with the provided credentials.
  • Authentication errors: Confirm that the API key credential is correctly configured and has sufficient permissions to invite members.
  • API rate limits or service downtime: If requests fail repeatedly, check for API rate limiting or service availability issues.
  • Error messages: The API response will typically include error details if the invitation fails; review these messages to adjust input parameters accordingly.

Links and References

Discussion