Skip to main content

Introduction

Embed Residently property listing and enquiry flows within your web application.

Getting Started​

Installation​

Get started by adding the Residently Embed SDK to your web application.

npm install @residently/embed-sdk --save

Usage​

In your web application import @residently/embed-sdk and instatiate a new client

import Residently from '@residently/embed-sdk';

// Create a Residently instance.
const residently = new Residently();

For example, to a embed a property listing collection, call embed

residently.embed('collection', {
  container: htmlElement,
  collectionToken: '<provided_by_residently>'
});

Events​

A Residently instance emits a variety of events depending on the view being embedded.

Support​

If you have any questions or issues with Residently Embed SDK or our API, please contact hello@residently.com.