Actions24
- Tag Actions
- Provider Link Actions
- Computer Actions
- Maintenance Actions
- Person Actions
- Tenant Actions
- User Actions
Overview
The node named "ImmyBot" is designed to interact with the ImmyBot API, providing automation capabilities around managing persons and related data. Specifically, the "Get Person" operation retrieves detailed information about a person by their unique ID. This node is useful in scenarios where you need to fetch user or contact details from ImmyBot for further processing, such as enriching CRM records, triggering workflows based on person attributes, or integrating with other systems.
Example use cases:
- Fetching a person's profile data to personalize communications.
- Retrieving user details before updating or deleting records.
- Integrating ImmyBot person data into reporting or analytics pipelines.
Properties
| Name | Meaning |
|---|---|
| Person ID | The ID of the person to retrieve (number). This is a required field when performing the "Get Person" operation. |
Output
The node outputs JSON data representing the retrieved person's details. The structure typically includes all available fields returned by the ImmyBot API for a person entity, such as name, contact information, status, and any custom attributes defined in ImmyBot.
If the node supports binary data output, it would be used to handle files or attachments related to the person, but this is not indicated in the provided code or properties.
Dependencies
- Requires an API authentication token configured via OAuth2 credentials for ImmyBot.
- Needs the subdomain of the ImmyBot instance to construct the base URL dynamically.
- The node depends on the ImmyBot REST API v1 endpoint.
Troubleshooting
- Missing or invalid Person ID: Ensure that the "Person ID" property is provided and is a valid number; otherwise, the API call will fail.
- Authentication errors: Verify that the OAuth2 credentials are correctly set up and have sufficient permissions.
- Network or API errors: Check connectivity to the ImmyBot service and confirm the subdomain is correct.
- Unexpected response structure: If the API changes, the node might return unexpected data; verify API version compatibility.
Links and References
- ImmyBot API Documentation (hypothetical link)
- OAuth2 Authentication setup in n8n documentation: https://docs.n8n.io/credentials/oauth2/