The Beekeeper Integration in Innform allows you to synchronize users (add/remove) between Beekeeper and Innform. With this integration, you can also use web hooks to automate actions when users are created, updated, or deleted in Beekeeper. Follow the steps below to connect your Beekeeper account and manage the sync process.
Prerequisites
Before you begin, ensure you have the following:
An Innform admin account with access to Account Settings.
Your Beekeeper API URL.
Your Beekeeper Bot Account Token.
Step 1: Accessing the Beekeeper Integration Settings
Log in to Innform.
Navigate to the side menu and select Account Settings.
In the settings menu, click on Integrations.
Locate and select the Beekeeper integration from the list.
Step 2: Connecting Your Beekeeper Account
On the Beekeeper integration page, click the Connect Beekeeper Account button.
A form will appear asking for your Beekeeper API URL and Bot Account Token.
Beekeeper API URL: Enter the URL provided by Beekeeper (https://<your_subdomain>.beekeeper.io/api/2/).
Bot Account Token: Input the token associated with your Beekeeper Bot Account.
Once both fields are filled, click Connect Beekeeper Account to establish the connection.
Note: At this stage, the connection is successful but the users will not be synced automatically.
Step 3: Configuring Web Hook Options
After connecting your Beekeeper account, you can activate web hook options to automate the synchronization process. The available web hook events are:
USER.CREATED: Triggered whenever a new user is created in Beekeeper.
USER.UPDATED: Triggered when specific user fields are updated.
USER.DELETED: Triggered when a user is deleted.
To activate these options:
On the same integration settings page, locate the Web Hook Options section.
Toggle or select the web hook options you wish to activate based on your needs.
Save your changes.
Step 4: Filtering users with a custom Beekeeper field (optional)
If you only want specific Beekeeper users to be synced to Innform, you can use a custom profile field to control who gets added. Users without this field set to YES will be ignored during sync, even if they exist in Beekeeper.
4a — Create a custom profile field in Beekeeper
Go to your Beekeeper admin dashboard → Settings → Profile Fields.
Add a new profile field with the following details:
Field name:
Add to InnformField key:
add_to_innform
Save the field.
4b — Configure the whitelist key in Innform
In the Beekeeper integration settings in Innform, locate the Whitelist Key field.
Enter
add_to_innformas the whitelist key.Save your settings.
4c — Tag users in Beekeeper
For each user who should be synced to Innform, open their profile in Beekeeper.
Find the Add to Innform field and set the value to
YES.Only users with this field set to
YESwill be added to Innform during the sync.
Note: Users without the add_to_innform field set to YES will be ignored during sync, even if they exist in Beekeeper.
Step 5: Syncing Users and Groups
Once your Beekeeper account is connected and your web hook options are set up, you have full control over the initial sync process.
Manual Sync:
To synchronize the users manually, click on the Sync Users button.
Sync Users and Groups (if applicable):
If you are also using Beekeeper Groups, click on Sync Users and Groups to ensure that both users and their associated groups are synchronized.
Important: The initial connection does not automatically sync your user data. The synchronization is triggered only when you initiate the sync process manually.
Final Notes
Control: You have full control over when the sync occurs. This allows you to review the integration settings and data before the actual synchronization takes place.
Automation: With web hooks activated, your integration can automatically update Innform as changes occur in Beekeeper, ensuring your system remains up-to-date.
Troubleshooting: If you encounter any issues during the integration, double-check that the API URL and Bot Account Token are correctly entered. For further assistance, consult our support documentation or contact our help desk.