Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node allows you to invite a user to an organization on the Straddle platform by sending an invitation email with assigned roles. It is useful in scenarios where you need to programmatically add users to your organization's platform account, specifying their access roles and optionally tracing requests for debugging.

Practical examples:

  • Automatically inviting new team members to your organization's platform with predefined roles.
  • Integrating user onboarding flows where invitations are sent as part of a larger automation.
  • Tracking invitation requests using custom request and correlation IDs for audit or troubleshooting purposes.

Properties

Name Meaning
Request Id Optional client-generated identifier to trace and debug a single request; sent as HTTP header.
Correlation Id Optional client-generated identifier to trace and debug a series of related requests; HTTP header.
Organization Id Identifier of the organization to which the user is invited; included in the request body.
Platform Id Identifier of the platform context for the invitation; included in the request body.
Email Required. Email address of the user to invite; included in the request body.
Roles Required. JSON array defining the roles assigned to the invited user; included in the request body.

Output

The node outputs the JSON response from the Straddle API after attempting to send the user invite. This typically includes details about the invitation status, any errors, and metadata returned by the API.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • The base URL for API requests depends on the configured environment (e.g., production or sandbox).
  • Proper network connectivity to the Straddle API endpoint.

Troubleshooting

  • Missing required fields: Ensure that the "Email" and "Roles" properties are provided; otherwise, the API will reject the request.
  • Invalid roles format: The "Roles" property must be valid JSON representing an array; invalid JSON will cause parsing errors.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Request tracing headers not working: If "Request Id" or "Correlation Id" are set but not reflected in logs, confirm that the API supports these headers and they are correctly passed.
  • Network issues: Check connectivity and firewall settings if the node cannot reach the Straddle API.

Links and References

Discussion