Actions81
- Users Actions
- Organizations Actions
- Representatives Actions
- Bridge Actions
- Platforms Actions
- Tools Actions
- User Invites Actions
- Customers Actions
- Paykeys Actions
- Reports Actions
- Charge Actions
- Funding Events Actions
- Payments Actions
- Payout Actions
- Accounts Actions
- Get Account By Id
- put__v1_accounts_account_id
- Create Account
- get__v1_accounts
- post__v1_accounts_account_id_onboard
- post__v1_accounts_account_id_simulate
- patch__v1_internal_accounts_account_id
- get__v1_internal_accounts_account_id
- patch__v1_internal_accounts_account_id_status
- get__v1_internal_accounts_account_id_settings
- Capability Requests Actions
- Linked Bank Accounts Actions
Overview
This node interacts with an internal onboarding tool API endpoint to send onboarding event data. It is designed to post structured event information related to platform onboarding processes, which can be useful for tracking and managing onboarding workflows in a system.
Typical use cases include:
- Sending onboarding event notifications or logs to an internal tool for audit or monitoring.
- Integrating onboarding status updates into a broader automation workflow.
- Debugging or tracing onboarding events by attaching client-generated identifiers.
For example, you might use this node to notify an internal dashboard whenever a new user completes the onboarding process, including detailed event metadata.
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 (header). |
| Event Id | Required unique identifier for the onboarding event being sent. |
| Event Type | Required type/category of the onboarding event. |
| Created At | Required timestamp indicating when the event was created. |
| Data | Required JSON object containing detailed data about the event. This should be a valid JSON string. |
Output
The node outputs the response from the onboarding API call in the json field of the output item. The structure depends on the API response but typically includes confirmation or details about the posted event.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authentication to the Straddle API environment.
- The base URL for the API is dynamically constructed based on the configured environment credential.
- The node sends JSON payloads and expects JSON responses.
- No additional external dependencies are required beyond standard HTTP request capabilities.
Troubleshooting
- Invalid JSON in Data property: Since the
datainput is parsed as JSON, invalid JSON strings will cause errors. Ensure the JSON is well-formed. - Missing required fields: The properties
eventId,eventType,createdAt, anddataare mandatory. Omitting them will likely cause API errors. - Authentication errors: If the API key credential is missing or incorrect, the node will fail to authenticate.
- Header issues: Custom headers like
request-idandcorrelation-idare optional but must be strings if provided. - API endpoint errors: Any server-side errors or validation failures from the onboarding API will be returned in the node's output and should be checked for troubleshooting.
Links and References
- No direct external links were found in the source code.
- For more information, consult the documentation of the internal tools platform onboarding API or your organization's API reference.