Skip to content

2. Installation

Jump to bottom
Falko Joseph edited this page Feb 21, 2024 · 18 revisions

Important: a license is required in order to publish properties to your website.

1. Installing Advanced Custom Fields Pro

  1. Make sure you have Advanced Custom Fields Pro installed on your website
  2. Enable the Advanced Custom Fields Pro plugin and fill in the license key

2. Installing WP SweepBright PRO

  1. Download the latest version of our plugin from the releases page.
  2. Rename the folder to from wp-sweepbright-<version> to wp-sweepbright
  3. Move the wp-sweepbright directory into wp-content/plugins
  4. Enable the plugin

Important notice: do not forget to rename the directory (step 2).

3. Configuration

Compagnon 2024-02-21 at 12 38 17@2x

Configuring the SweepBright API credentials

In order for proper testing to work, it's useful to fill in your SweepBright API credentials on beforehand. You can do this on the "Settings" tab of the plugin (see screenshot). Fill in SweepBright's Client ID and Client Secret. These can be obtained here:

Configuring Google reCaptcha

The plugin is shipped with built-in reCaptcha, which are used for the contact forms. It's important to fill in these keys, in order for the built-in SweepBright contact forms to work.

4. Verifying your website

When you're ready to try out the SweepBright integration, let us know the name of your WordPress installation. We will add it to our whitelist, so your plugin is licensed.

5. Final step: adding the webhook to SweepBright and receiving the API credentials

In order to publish properties from SweepBright to your website you need to send the plugin's webhook URL to SweepBright. You will also need to obtain the Client ID and Client Secret codes. You will need to add these to the plugin's settings.

More information about about obtaining the API credentials can be found here:

https://get.sweepbright.help/en/articles/2529969-get-a-client-id-and-client-secret-to-build-an-integration-with-the-website-api

The plugin's webhook URL is using the following pattern:

https://yourdomain.com/wp-json/v1/sweepbright/hook

Replace yourdomain.com with your website's (temporarily) URL.

7. That's it!

SweepBright is now connected. You're now ready to go and build your own SweepBright powered website!

Next, check out our wiki for the rest documentation.

Clone this wiki locally