Unipile icon

Unipile

Interact with Unipile API

Overview

The node integrates with the Unipile API, specifically allowing users to send invitations related to the "User" resource. This operation is useful for scenarios where you want to programmatically invite users via the Unipile platform by sending a custom JSON payload describing the invitation details.

Practical examples include:

  • Automating user onboarding by sending invitation emails or notifications.
  • Integrating Unipile user invitations into workflows that trigger based on external events.
  • Customizing invitation content dynamically using JSON input.

Properties

Name Meaning
Body (JSON) Raw JSON body to send an invitation. This should contain all necessary fields as expected by the Unipile API for the invitation.

Output

The node outputs JSON data representing the response from the Unipile API after attempting to send the invitation. The structure of this JSON depends on the API's response format and typically includes information about the success or failure of the invitation request, such as status codes, messages, or details of the invited user.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured via credentials (likely an environment-specific DSN).
  • The node expects the Unipile API to be accessible and properly configured to accept invitation requests.

Troubleshooting

  • Invalid JSON in Body (JSON): If the JSON provided is malformed, the API call will fail. Ensure the JSON syntax is correct.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key or token is correctly set up in n8n credentials.
  • API Endpoint Issues: If the base URL or endpoint is incorrect or unreachable, the node will not be able to send the invitation. Check network connectivity and credential configuration.
  • API Response Errors: The API might return errors if required fields are missing in the JSON body or if the invitation cannot be processed. Review the API documentation for required fields and validate the JSON accordingly.

Links and References

Discussion