ImmyBot icon

ImmyBot

ImmyBot Node
Join our community

Actions24

Overview

The node implements the "Create Person" operation for the "Person" resource in the ImmyBot system. It allows users to create a new person record by providing essential personal details such as first name, last name, email address, and tenant association. Optionally, an Azure Principal ID can be included.

This node is beneficial in scenarios where automated workflows need to onboard or register new individuals into the ImmyBot platform, such as HR automation, user provisioning, or contact management systems.

Example use case: Automatically creating a new person entry when a form is submitted on a website or when a new employee joins a company, ensuring their data is synchronized with ImmyBot.

Properties

Name Meaning
First Name The first name of the person to be created (required).
Last Name The last name of the person to be created (required).
Email Address The email address of the person to be created (required).
Tenant ID The numeric identifier of the tenant this person belongs to (required).
Azure Principal ID Optional Azure Principal ID associated with the person, used for identity integration.

Output

The node outputs JSON data representing the newly created person object as returned by the ImmyBot API. This typically includes all the person's details such as their unique ID, names, email, tenant association, and any other metadata provided by the service.

If the node supports binary data output, it would generally relate to attachments or files linked to the person, but based on the provided code and properties, no binary output is expected for this operation.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials to connect securely to the ImmyBot API.
  • The base URL for API requests is dynamically constructed using a subdomain value from the credentials.
  • The node expects the ImmyBot API to be accessible and responsive at the constructed endpoint.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 credentials are correctly set up and have valid tokens.
  • Validation errors: Missing required fields like first name, last name, email, or tenant ID will cause the API to reject the request. Verify all mandatory inputs are provided.
  • API connectivity issues: Check network access to the ImmyBot API endpoint and confirm the subdomain in credentials is correct.
  • Invalid Azure Principal ID: If provided, ensure the Azure Principal ID is valid and correctly formatted; otherwise, the API might return an error.

Links and References

Discussion