Configuring TuriTop WebHooks

Available for plans: VIP | Enterprise

Where can I find it? Company >>> Components/Integrations. 

 Keep in mind: Regarding signatures for webhooks, it's something optional that adds another layer of security. It allows you to add any key you want on the turitop panel, so that when you receive our webhook notifications, you can check if it contains the same key added in TuriTop panel. If the key doesn't exist or is not correct, it means it was not made by us.

Step 1: go to your company's tab

Log into your TuriTop's dashboard >>> Company >>> Components/Integrations >>> Webhooks:

Here you need to enter a valid URL that redirects to a valid endpoint. Our system will send specific details to this endpoint. This will depend on the action, described in the next step.

Step 2: select an action

Once you have entered a valid URL, you need to select the action that will be performed from TuriTop to the endpoint. Currently, we have three actions available (This list will grow larger in time). Click on "Action" and this will deploy the following:

 Keep in mind: if you select all, this will send whichever action is done, e.g. new booking, update booking or delete the booking.  

As you can see in the image above, you have three action calls:

• All: this action call will perform all data sends to the target URL.
• New booking: this will send information regarding a newly created booking.
• Update booking: refers to the data sent when a booking is edited. There are two ways in which a booking can be edited: through an API call or a back-office call, respectively. 
• Delete booking: when you erase a booking, this will be notified through the webhook call. 

Step 3: add the webhook to your list

The final step is to click on add and you will have successfully added a webhook call. It should look like this:

Step 4: test your webhook

The next action you'll need to perform is, test your newly created webhook. To do this, click on the "Send test Webhook" button. A pop-up will be prompted: 

Enter a booking ID and click on accept. 

Security

If you need to add an extra level of security to your  Webhooks, you can use a signature. The latter will be used to create a JWT Token (https://jwt.io/) that adds authenticity and register the exact date in which the webhook was sent.

To create the signature, you just need to fill the 32 characters to the signature when configuring your webhook; a new field called "Token" will be added to every call.

 To decode it, you need to use the standard JWT library (https://jwt.io/#libraries-io) in order to verify with your signature that the token (and the webhook, accordingly) is valid and sent by TuriTop legitimately. 

You will finally get redirected to your application or webhook tester. This will be sent in POST and JSON format:

 Keep in mind: the "action" parameter is the result of the "action" that you pre-selected when adding the webhook. Moreover, when you set it to "all" it will return any of the three actions explained above, e.g. new booking, update booking or delete booking, meaning that you won't see "All" in the Action parameter. 

 Warning: the HTTPS protocol is mandatory for the use of webhooks. Do not attempt to use standard HTTP because it won't work.