How to Add Webhooks

Are you looking to send certain information to a third party software when an event occurs in Rentvine? This article will show you how to add a webhook which will accomplish this.

 

What is a Webhook? A webhook is an HTTP request, triggered by an event in a source system and sent to a destination system, often with a payload of data. Webhooks are automated, in other words, they are automatically sent out when their event is fired in the source system.

 

  • To add a webhook you will need to click on the ellipses in the bottom left of the screen and click on settings.

Screenshot 2024-05-22 at 10.24.31 AM

Screenshot 2024-05-22 at 10.26.34 AM

  • Under the "Other" box you will click on the setting labeled "Webhooks" 

Screenshot 2024-05-24 at 3.09.23 PM

 

  • From this page, you can click the green actions button and click "New Webhook". 

Screenshot 2024-05-24 at 3.10.04 PM

 

  • You will then select an event. This event will record when an action occurs in Rentvine and it will be sent out to the designated URL.

Screenshot 2024-05-24 at 3.10.37 PM

 

  • The next thing you will enter is the "Post URL". This will be the designated URL that the event information is sent to when it occurs in Rentvine. When you are done you can click "Add" to save that webhook. 

 

  • If you click the ellipses on the right side of this webhook you will be able to edit it to change the event/URL or delete it to remove this webhook. 

Screenshot 2024-05-24 at 3.11.17 PM

 

  • Also from the green actions button, you will have the option to view the signing key.This key is used to sign all HTTP payloads that we send to your webhook receivers. This is used to confirm the data is being sent from Rentvine. 

Screenshot 2024-05-24 at 3.11.50 PM

Screenshot 2024-05-24 at 3.12.16 PM

If you ever need to change this signing key you can click the reset icon and this will generate a new unique key. Please note that this will invalidate the old key and you will need to update the webhook receivers of the new key. 

Screenshot 2024-05-24 at 3.13.08 PM