Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node interacts with the "Users" resource of an API to retrieve information about invited users based on their email address. Specifically, the operation get__v1_internal_users_invited fetches details about users who have been invited but not necessarily accepted or completed registration.

Common scenarios where this node is useful include:

  • Verifying if a user with a specific email has been invited to a system.
  • Auditing or tracking invitation statuses for compliance or operational purposes.
  • Integrating invitation status checks into automated workflows, such as sending reminders or follow-ups.

Practical example:

  • A workflow that triggers when a new invitation email is sent and uses this node to confirm the invitation was registered in the system before proceeding with further onboarding steps.

Properties

Name Meaning
Email The email address of the user to look up among invited users.
Request Id Optional client-generated identifier to trace and debug a single request (sent as header).
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header).

Output

The node outputs JSON data representing the invited user(s) matching the provided email. The structure typically includes user details as returned by the API, which may contain fields like user ID, invitation status, timestamps, and other metadata related to the invitation.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication to the Straddle API.
  • The base URL for API requests is dynamically constructed using the environment specified in credentials.
  • The node sends HTTP requests with headers including Accept: application/json and Content-Type: application/json.
  • Optional headers request-id and correlation-id can be set for tracing/debugging purposes.

Troubleshooting

  • Empty or no results: If the email does not correspond to any invited user, the output will be empty or null. Verify the email input is correct.
  • Authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
  • Request tracing: Use the optional Request Id and Correlation Id properties to help trace and debug requests in logs or monitoring tools.
  • API endpoint issues: Confirm the environment value used to build the base URL is valid and reachable.

Links and References

Discussion