Using Rentsync's Webhook API

The Rentsync Webhook API transmits data between Rentsync and third-party systems.

Rentsync uses webhooks to notify your application when an asynchronous event (in this case, incoming lead data from an ILS directory) happens in your account. Lead data can be forwarded to your system of choice based on your setup.

Begin using webhooks with your Rentsync integration in just two steps:

  1. Create a webhook endpoint on your server.
    • For the receiving leads this must be a POST method.
    • Your webhook should communicate with your system of choice’s APIs. This is a one-time technical setup done by a Software Developer from your organization.
  2. Register the endpoint with Rentsync to go live.
    • Click "Ad Syndication" from the main menu. 
    • Choose "Integrations" from the secondary menu.
    • Provide the Key and Endpoint URL. Click the “Save” button.

Before you turn the Webhook “on”, you can use the testing tool to send a test lead as a way to validate your setup.

Once the “Send ILS Leads via Webhook” option (toggle) is “on” and saved, Rentsync’s webhook will automatically transmit data related to leads pertaining to your customer ID.

The request body sent will be of this format:

{

  auth: {

    key: "optionalkeysetbyclient"

  }

  data: {

    "adUrl": "",
    "adTitle": "195 Test Street: 2 Beds 1 Bath",
    "comment": "Can I arrange a viewing?",
    "fullName": "Jane",
    "email": " janedoe@​gmail.​com",
    "phone": "(514) 111-2222",
    "unitModel": "195 Test Street: 2 Beds 1 Bath",
    "parser": "padmapperParser001",
    "source": "padmapper",
    "inboundEmailId": 1111111,
    "sentAt": "Tue Aug 10 2021 23:​19:​09 GMT+0000 (Coordinated Universal Time)",
    "recipientEmail": "testemail@email.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "clientKey": "rentsync",
    "buildingId": `12345,
    "propertyName": "Test Building"

  }

}

This request sent to your endpoint can be processed as you wish. It can be stored in a database, or displayed real-time on an incoming leads feed.