Skip to content

BirdEye

The ProfitSystem integrates with BirdEye. BirdEye provides a variety of services to retailers, and ProfitSystem integrates with their reputation/review management system.

When specific events occur in ProfitSystem, it makes an API call to BirdEye and sends specific details about the event. BirdEye will have triggers that will act on these events based on the retailers needs.

The following events are sent to BirdEye. The actual data sent is documented below.

  1. Appointment is confirmed.
  2. Appointment is canceled.
  3. Appointment is updated.
  4. An item picked up by the customer.

Getting started

  1. Contact BirdEye and sign up for their review/reputation service. Be sure to indicate that you are using the ProfitSystem from BBL Systems and Solutions.
  2. You must be using the Appointment module in the ProfitSystem.
  3. Enable BirdEye by going to the E-Commerce/Integrations tab, and entering your Business ID and API Key.
  4. If using switchboards, it's located at Housekeeping->General Setup->Stores->E-Commerce/Integrations tab.
  5. If using menus, go to Setup->General Setup->Stores->E-Commerce/Integrations tab.
  6. The Business ID and API Key are provided by BirdEye. To view them, log into your BirdEye account.
  7. Go to the Account menu option on the left side of the page, and then choose Developers from the top menu.
  8. The Business ID and API Key are shown. Copy them into the ProfitSystem on the E-Commerce/Integrations tab.
  9. Click Save in the ProfitSystem, then restart the program.
  10. The integration is enabled.

Technical details

Multi-store operations will have a different Business ID and API Key for each store.

The additionalParams sent depend on the Communication type element. For appointments, the appointment time is sent as a UTC time string format.

For the sale pickup, the pickup date is sent in MM DD, YYYY format. The category for the sale pickup is the department/category of the sale item.

  • Appointment is confirmed
{
"emailId": "test@example.net",
"name": "Kailie Jones",
"phone":"412-555-1212",
"smsEnabled": 1,
"additionalParams": {
    "Communication type": "APPOINTMENT_CONFIRMED",
    "appointmenttime":"2024-06-03T13:30:00Z",
    "appointmenttype":"M_NEW"
    }
}
  • Appointment is canceled
{
"emailId": "test@example.net",
"name": "Kailie Jones",
"phone":"412-555-1212",
"smsEnabled": 1,
"additionalParams": {
    "Communication type": "APPOINTMENT_CANCELED",
    "appointmenttime":"2024-06-03T13:30:00Z",
    "appointmenttype":"M_NEW"
    }
}
  • Appointment updated
{
"emailId": "test@example.net",
"name": "Kailie Jones",
"phone":"412-555-1212",
"smsEnabled": 1,
"additionalParams": {
    "Communication type": "APPOINTMENT_UPDATED",
    "appointmenttime":"2024-06-03T13:30:00Z",
    "appointmenttype":"M_NEW"
    }
}
  • Sale item is picked up by customer. Could be from a stock sale or special order.
{
"emailId": "test@example.net",
"name": "Regan Jones",
"phone":"814-555-1212",
"smsEnabled": 1,
"additionalParams": {
    "Communication type": "PICKUP_DONE",
    "category":"Bridesmaid",
    "vendorStyle":"1860",
    "price":166.99,
    "pickedup":"5 23, 2024"
    }
}