Where can I find the Website API Documentation?
The documentation lives on this link: https://docs.website.sweepbright.com
All of my publications are showing an error
Typically, two things can cause this:
Your integration did not respond in time. There is a hard requirement for your integration to send a 200 OK response with a URL within 60 minutes of the webhook receiving a call.
You might be using the wrong credentials. Make sure that you are using the correct combination of the Client ID and Client Secret that you find in the Publication Channels → Portals section of the SweepBright Web App.
Some of my publications are showing an error
Typically, this happens when your integration did not respond in time. There is a hard requirement for your integration to send a 200 OK response with a URL within 60 minutes of the webhook receiving a call. We advise you to always respond in time, even if the processing time on your side is slower than 60 minutes.
How do I mark a publication as failed?
You do not have to mark a publication as failed explicitly. If SweepBright does not receive a 200 OK response within 60 minutes, we fail the publication on our side.
How do I handle files like images, documents and plans?
SweepBright handles three different types of files for properties: images, documents and plans. Customers can set the visibility of these files through the SweepBright Apps. A file can be either public or private. The Website API exposes only public files. We generate a temporary URL for each file. You should use this URL to download the file and store it locally. The URLs will expire 2 hours after fetching the Property.
For all files, including images, we expose only the original file. It's a best practice to convert these images locally when your application requires it.
Where can I find a list with all possible fields for a Property in SweepBright?
You can find a list with all fields in the SweepBright Property model on this link: https://docs.fields.sweepbright.com/doc/sweepbright__property/