How to enable BOXit

1. Go to the client’s Dashboard and create a new User called “BOXit Webhook.” Give this user the highest permission group available.
2. From the “BOXit Webhook” user’s settings, navigate to the API Keys tab. Add a new API Key, and name it “BOXit Webhook.”

3. Click Edit on that new API Key. On this Edit page, you’ll see a blank field for a Webhook URL. Paste the following URL into that field, and then hit Save. You will receive the specific URL from BOXit or the client.

   The Webhook URL is essentially the address where BOXit will receive the client’s booking details. Once this URL is plugged in, the Webhook is immediately activated, and BOXit will begin receiving the booking details for any and every booking created on this Dashboard, in real-time.

4. Once this is done, send an email back to the client with BOXit Customer Success cc’d (office@boxit.at) to confirm the integration has been enabled on FareHarbor’s end. In this email, you must also indicate the client’s FareHarbor shortname. The shortname is how BOXit will know how to identify the client’s bookings – so it is important to share that with them.

   Hi _______,

   Thank you for getting in touch. We have enabled the BOXit integration on your FareHarbor Dashboard. For the BOXit Team – Company XZY’s FareHarbor shortname is “companyxyz.”

   Please let us know if we can assist with anything else.

5. Now that the webhook is enabled, you must trigger it for the existing bookings in that Dashboard. The webhook must be enabled first before this next step is taken. Please follow the steps in the next section.

The webhook will automatically send BOXit every booking moving forward, but action is still required in FareHarbor to send BOXit any existing bookings for future dates. Here are the required next steps to ensure that we send BOXit every future booking that they need in their system.

1. Run a report to see existing bookings for future dates

   Run a Detailed Bookings report in the charter company’s Dashboard to see all bookings for future availability dates. It is best to select a custom date range starting with today’s date and ending with 2 years from that date (or as far out as that company has future bookings.)

2. Initiating the webhook for each future bookings

   The Business Intelligence script can automate webhooks for companies with 100 or more future bookings (if there are fewer than 100 future bookings, follow these steps instead)

To send an automation request to the Business Intelligence team:

1. Click the “Share” button within your report, and copy the unique report URL.

2. Paste that report URL into a FareHarbor Automation submission request form

   

3. In the “Select Automation Type” field, select “Webhook Update”.
4. In the “Date automation can start” field, enter today’s date.
5. In the “Maximum date of completion” field, enter 5pm of the next business day.
6. In the “Link to FareHarbor report of bookings” field, paste the URL of your future bookings report.
7. Reference this help page for more information about submitting this type of form.

Manually initiating the webhook when there are fewer than 100 future reservations:

When there are fewer than 100 future reservations, the webhook can be initiated by opening each booking in the report and “touching” the booking:

1. Open the booking and click Edit contact.
2. Remove and re-add the contact information by cutting and pasting.

3. Save your changes to trigger the webhook.

   Watch video example

Check to see if the client’s Dashboard has a “BOXit Webhook” User, and check that the Webhook URL in their API key has a Webhook URL.

Webhook activity will also be shown within the history of each individual booking in that Dashboard. For example, after a booking is created, the next event in that booking history should read: “External API Booking Webhook request succeeded (BOXit: BOXit Webhook)”.

Note: All webhook activities in a booking are visible to Admins only.

1. Go into the Dashboard’s settings and select Users & Permissions.
2. Select BOXit Webook > Edit.
3. Select API Keys > Edit.
4. Select Delete API Key.
5. Once the API Key has been deleted, deactivate the BOXit Webhook user:
   1. Within the BOXit Webhook user, select account.
   2. Select permissions.
   3. Update user status to deactivated.
   4. Click Save.