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 performs an internal account onboarding operation by sending a POST request to a specific API endpoint related to "Tools". It is designed to submit onboarding event data, including event identifiers, timestamps, and detailed JSON data about the onboarding process. This node is useful in scenarios where automated systems or workflows need to notify or log account onboarding events into an internal tool or service for tracking, auditing, or further processing.
Practical examples include:
- Automatically reporting new user account creation events with associated metadata.
- Sending onboarding status updates from external systems into a centralized tool.
- Integrating onboarding event streams into monitoring or compliance platforms.
Properties
| Name | Meaning |
|---|---|
| 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). |
| Event Id | Required unique identifier for the onboarding event being reported (sent in request body). |
| Event Type | Required type/category of the onboarding event (sent in request body). |
| Created At | Required timestamp indicating when the event was created (sent in request body). |
| Data | Required JSON object containing detailed data about the onboarding event (sent in request body). |
Output
The node outputs the JSON response received from the API after submitting the onboarding event. The structure of this JSON output depends on the API's response but typically includes confirmation details or status information about the onboarding event submission.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authentication to the target API.
- The base URL for the API is dynamically constructed based on the environment specified in credentials.
- The node sends HTTP POST requests with JSON payloads and expects JSON responses.
- Proper configuration of the API authentication and environment variables within n8n is necessary.
Troubleshooting
- Missing required properties: Ensure that
Event Id,Event Type,Created At, andDataare provided; otherwise, the API may reject the request. - Invalid JSON in Data property: The
Datafield must be valid JSON; invalid JSON will cause parsing errors before the request is sent. - Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Network or connectivity issues: Confirm that the environment variable used for the base URL is correct and that the API endpoint is reachable.
- Unexpected API responses: Check the API documentation for error codes and messages returned in the JSON response to diagnose issues.
Links and References
- No direct links available from the source code.
- Refer to the API provider’s official documentation for detailed information on the onboarding event schema and API usage.