Connecting Your Revel Integration

 


To ensure a successful Bbot and Revel integration, you will need to configure a custom payment type that includes "bbot" in the name, of your Revel Account. For more info, check out this article. Bbot will not be able to connect to Revel without the Bbot Payment method. Once the "Bbot" Payment method has been configured please proceed to the Bbot Owner Panel.

Connect Revel in Bbot

Log in to your Bbot Owner Panel and navigate to the 'Bbot App Store' under 'Integrations'.

Locate the 'Revel Orders + Menus' integration, and click the blue 'Connect Revel' button.

Enter the API information into the fields shown below and then click the 'Submit' button to save the settings.

API URL for Revel: This is the unique URL for your Revel account ([yoursubdomain].revelup.com). When you enter this to connect the integration you will enter it without including .revelup.com.

API Key for Revel: This will be provided by Revel and is a unique webhook that will allow orders to be injected from Bbot to Revel.

API Secret for Revel: This is a unique 14-23 character credential provided by Revel.

As a Revel customer, you will have a unique API Key/Secret provided by Revel. In order to receive it, you will need to complete Revel’s Onboarding Setup Process by sending an email to Revel’s Partner Connect team at partnerconnectsetup@revelsystems.com in addition to configuring the integration within Revel. 

In the Revel Establishment dropdown, you will need to select your location and click the 'Submit' button.

Select the desired behavior settings (described below) for the integration, then click 'Submit.'

• Inject orders into Revel: This must be enabled for orders to be injected into the Revel POS. The following settings are only applicable if this setting is enabled.
  • If not selected: Revel menus will sync and display on your Bbot ordering site. The Bbot KDS will be used to fulfill orders placed with Bbot, and the Bbot Owner Panel will be used for all reporting and accounting associated with these orders. If selected: Orders placed with Bbot will inject directly into the Revel system to be fulfilled with the Revel KDS. These orders will display 'Online Ordering - Bbot’ at the top of the ticket, both digital and physical. Bbot orders will automatically factor into Revel accounting and will be filtered into ‘Online Ordering orders’ in Revel reports.
• Ticket Call Name Template String: This setting is used to inject a call name for the order in Revel, by utilizing specific properties of the Bbot order. The available strings are listed below. Please Note: The String must include the '$' sign, be written in all upper case letters, and be written exactly as they are written below.
  • $ORDER_NUMBER - Order number 
  • $LOCATION - Location's name
  • $PATRON_NAME - Patron's name
  • $ROOM - Room number 
  • $PATRON_PHONE Patron's phone number
  • $PATRON_EMAIL - Patron's email address

* Please Note: Revel order number displayed in the terminal is different than the BBot order numbers, so er recommend we enter the Order Number and Patron Name in the Ticket Call Name Template String to help in-store staff locate and distribute orders. 

• Customer Name Template String: This setting is used to inject the Customer Name for the ticket. The Customer Name will be visible on the KDS. The Strings listed below are the order properties that can be added to the Customer Name field in Revel. Note: The String must include the '$' sign, be written in all upper case letters, and be written exactly as they are written below.
  • $ORDER_NUMBER - Order number 
  • $LOCATION - Location's name
  • $PATRON_NAME - Patron's name
  • $ROOM - Room number 
  • $PATRON_PHONE Patron's phone number
  • $PATRON_EMAIL - Patron's email address
• Inject Bbot order data as customer data: If selected, Bbot orders will include the Bbot location code in the ‘Instructions’ field for orders in Revel.
• Display order number on Revel ticket: If selected, Bbot orders will include the Bbot order number in the ‘Instructions’ field for orders in Revel.
• Display fulfillment method on Revel ticket: If selected, Bbot orders will include the Bbot fulfillment method in the ‘Instructions’ field for orders in Revel.
• Display checkout info on Revel ticket: If selected, Bbot orders will include all Bbot checkout info (other than name, phone number, email, and address, which are always sent to Revel if provided) in the ‘Instructions’ field for orders in Revel.
• Sync Refunds from Revel: Any refunds made on orders in Revel will sync with the associated order in Bbot. You will also need to reach out to Revel Support to have the Refundn webhook enabled for Bbot. Refunds will only work for item or full order refunds, percent-based refunds will not pull over into Bbot.
• Keep Bbot Quantity Limits Instead of Revel Quantity Limits: If this is checked, the minimum or maximum quantities on modifiers from Revel will be overwritten with whatever is set in Bbot when possible. This is equivalent to the Maximum modifiers per group and Minimum modifiers per group settings in Revel. Please see the examples below.
  • Equivalent to "Unlimited Choices" in Bbot 
    
  • Equivalent to "Choose Up To One" in Bbot
  • Equivalent to "Choose Exactly One" in Bbot 
  • Equivalent to "One Required to Choose Up To Three" In Bbot 
• Ignore Revel Inventory for Item Availability: When selected, this will be ignored if an item is marked in or out of stock when the menu sync is received from Revel.  
• Custom Dining Option: Bbot allows you to inject orders into specific dining options in Revel. This will allow merchants to customize how Bbot orders are shown on the Revel KDS 
  • Custom Dine-In Dining Options - Select the Rvel Dinning option that you want Bbot "Server Delivery" or Counter Service" orders to inject into Revel as.
  • Custom Dine In To Go - Select the Rvel Dinning option that you want Bbot "Takeout" orders to inject into Revel.
  • Custom Dine-In Dining Options - Select the Rvel Dining option that you want Bbot "Delivery" orders to inject into Revel.
• Import Unque Modifiers Per Menu Items: This setting should be used if there are menu items in Revel that have customized prices for specific modifiers that differ from the base price set on the modifier itself. Please see the example below where the Modifier Base price differs from the price set for the same modifiers under a specific menu item. As you can see above the modifier prices do not match the prices set for the same modifiers under a specific menu item, as seen below.

How Other Specific Menu Settings in Revel are reflected in Bbot

• DFLT QTY settings on modifiers: This setting will determine if a modifier is preselected as well as the quantity of the preselected modifier. When the default modifier is deselected in Bbot the modifier will be injected with a "No" in front of the modifier, if this setting is enabled in Revel.
• MAX QTY settings on modifiers: In Revel '0' indicates that an unlimited number of this modifier can be added to the order, Bbot reads '0' as a '1' and will only allow the guest to select the modifier once. A '1' will only allow the guest to select the modifier once in Bbot. If you want to allow the guest to add an unlimited amount of a single item then you will want to set the MAX QTY to '99' for that item. Bbot cannot add a single modifier more than 99 to a menu item. The number of total number modifiers that a guest can add will still be limited by the Modifier Group Quantity Limit.
• All Modifiers that are marked as "Active" for a specific item will be injected into Bbot and will be offered as a modifier in Bbot. We understand that you may have this set so that your staff can add any available choice when ringing in an order. However, you may want to reduce the number of choices offered to your guests on your Bbot Menu. You can disable modifiers for specific menu items by disabling the modifier in the Bbot Menu Editor. Note: There will likely be multiple menu items with the same modifier, you can isolate the exact modifier that needs to be disabled by referring to the "Modifier For" column on the Bbot menu editor. This column will indicate exactly which menu item is utilizing that specific modifier. Please do not mark the item as out of stock as the "Item Out Of Stock" setting pulls directly from the Revel and will be re-set as soon as the next menu sync is performed.
• All Bbot individual orders, including orders that are part of a Bbot Tab, will be injected into Revel as a closed order. Bbot collects the payment for orders as soon as they are placed and closes the order out as 'paid' in Revel.
• Service Charges/Fees: do not need to be configured in Bbot. Service Fees will be configured in Revel to apply automatically to specific orders. When a Service Fee is applied to orders in Revel it will automatically show to the guest in Bbot.
   

Limitations to the Revel integration

• Bbot Table Mapping: Bbot does not have the ability to inject orders into a specific table in Revel POS, However, the table number (Bbot Location Code) will be included on the kitchen ticket so that staff members know exactly where an order needs to go.

* If another POS integration is already connected, you will be prompted to disable that integration before enabling the Revel integration. If there are existing menu items in Bbot, you will be prompted to delete all menu items in order to activate the integration.