Set Up Guide
Before setting up the integration in MyBlackbird, you will need to obtain your specific integration information. Each Leaf Logix account has a specific key that allow third party software platforms to share and receive select information. The key is needed to securely access the Leaf Logix account for integration with Blackbird. You will need to request the key from their Leaf Logix account representative.
How to Find It
The API Key is a long string of letters and numbers that is specific to each instance of Leaf Logix.
Each Key is configured by Leaf Logix staff with access to the specific information needed for the integration. In this way, LL will configure the API key with access to endpoints with information specific to features needed for the integration. When you request the API key, you should also provide your Leaf Logix account rep with the endpoints you need enabled. Below this table is another table that defines the endpoints needed for each feature of the integration.
Provided by a Leaf Logix Account Rep
API Key Endpoints Needed for Integration
Leaf Logix will need to grant access specifically for the endpoints that support the features used in the integration. For example, if the integration is being used for an online menu, Leaf Logix will set up the API Key with access to the endpoints that have product and inventory information. Below is a list of the endpoints clients should ask for access to based on the features they are using the integration for.
Endpoints to Ask Leaf Logix For
Set Up Steps
Once you have obtained all the required information from Leaf Logix, setting up the integration is as simple as entering those fields into MyBlackbird. Navigate to the Settings & Configurations Block and then choose the Integrations Hub Block.
Enter Authorization Info
Select Leaflogix from the Point of Sale drop-down and enter the API Key.
Once the authorization information is entered, you will be prompted to choose the sync functionality you would like to have with the integration.
Product Sync - You should enable this if you plan to use the integration to facilitate an online menu. This sync will pull inventory from Leaf Logix rooms that are available for E-commerce.
Customer Sync - You should enable this if you plan to use a loyalty program where customers earn points for completed orders. This sync pulls customer information from Leaf Logix into Blackbird and allows Blackbird to associate customer info with orders, when available.
Order Sync - You should enable this if they plan to use a loyalty program where customers earn points for completed orders. This sync pulls in order information for completed orders in Leaf Logix. When used with a loyalty program, orders will be used to award customers points for their purchase.
Notification Email - Adding a notification email is optional for those using a menu. It is used to send email notifications of new orders received on a Blackbird menu. It is not necessary to use this if order push is enabled, but can be a nice additional feature to make sure staff is getting notified of new orders that need to be fulfilled.
Please Note: If you have preorder notifications enabled in your point of sale, you may not want to add a notification email in MyBlackbird to prevent duplicate emails being sent from both platforms.
Once all info is added and the desired functionality is enabled, the last step is to set the integration Active and save the configuration information. The integration can be deactivated at any time.
Monitoring Integration Activity
Monitoring the information shared between Leaf Logix and Blackbird is easy! Users can navigate to the Activity Log within their Integration Hub to see what information is being pulled from Leaf Logix, how frequently new info comes in and if there are any errors with the integration.
Was this article helpful? Let us know below! We’re always trying to improve and would love to see your feedback.