ImmyBot icon

ImmyBot

ImmyBot Node

Actions24

Overview

The node implements an integration with the ImmyBot API, specifically providing functionality to create a new person record within a tenant. This operation is useful in scenarios where you need to programmatically add user or contact information into the ImmyBot system, such as onboarding new users, syncing contacts from other systems, or automating user management workflows.

For example, you might use this node to:

  • Automatically create a person profile when a new employee joins your company.
  • Sync customer data from a CRM into ImmyBot for personalized interactions.
  • Add participants to a tenant's directory based on external event registrations.

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 under which the person will be created (required).
Azure Principal ID Optional Azure Principal ID associated with the person, if applicable.

Output

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

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, the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the ImmyBot service.
  • The node expects a configured subdomain credential parameter to construct the base URL for API requests.
  • Network access to the ImmyBot API endpoint (https://{subdomain}.immy.bot/api/v1) is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly set up and has sufficient permissions.
  • Invalid tenant ID: Verify that the tenant ID exists and the authenticated user has rights to create persons under it.
  • Missing required fields: The node requires first name, last name, email address, and tenant ID; missing any will cause validation errors.
  • API connectivity issues: Check network connectivity and that the subdomain is correctly specified in credentials.
  • Duplicate email addresses: If the API enforces unique emails per tenant, attempts to create a person with an existing email may fail.

Links and References

Discussion