How to enable vQuip

1. From the client’s Dashboard, go to Settings > Users & Permissions and create a new user:

   • Name: “vQuip Webhook API”
   • Username: vquip
   • Email: vQuip+Webhook+API@gmail.com.

   Give this user the API read only permission.

   If there is no API read only user permission, see Step 4. If there is, see Step 5.

2. Within the settings of that new “vQuip Webhook API” user, navigate to the API Keys tab. Add a new API Key, and name it “vQuip Webhook API”.

   

3. Click the Webhooks tab and fill in the following information:

   • Webhook Name: vQuip Webhook.
   • Webhook schema: Bookings only (Optimized)
   • Webhook URL: Add the webhook vQuip provided you with (vQuip’s Webhook URL will be unique for every FareHarbor client.)

   • Trigger for: Updated bookings

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

4. Go to Settings > Users & Permissions > Permission groups. Then select a user permission and duplicate that.

   • Once duplicated, we need to rename this user to “API Read Only” and make sure the check boxes are the same as these ones. Click Save.
   • Add this permission to the “vQuip API” user.

5. Next, we will need to copy the API Key and paste it in this Google Doc.

6. Once this is done, follow the Triggering the webhook steps below.

7. Please tag @software-partnerships in #softwarepartnerships to let us know that the vQuip integration has been set up and that you have taken all the steps above.

   • Do this BEFORE LETTING VQUIP KNOW IT IS COMPLETE.

8. If you have finished with all the above steps and received a response from Software Partnerships, let vQuip know you have completed the integration.

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

1. Run a Detailed Bookings report in the charter company’s Dashboard to see all existing 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 booking: The Business Intelligence script can automate webhooks for companies with 100 or more future bookings to send an automation request to the Business Intelligence team. (If there are fewer than 100 future bookings, follow these steps instead)
   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.

When there are fewer than 100 future bookings, 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.

1. Check to see if the client’s Dashboard has a “vQuip” User, and check that the Webhook URL in their API key has a Webhook URL.
2. 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 (vQuip: vQuip).

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 vQuip Webhook > Edit.
3. Select API Keys > Edit.
4. Select Delete API Key.
5. Once the API Key has been deleted, deactivate the vQuip Webhook user:
   1. Within the vQuip Webhook user, select Account.
   2. Select Permissions.
   3. Update user status to deactivated.
   4. Save.