Getting setup with Community Sift is pretty easy. Here's how it works.
Our goal is to make your life easier — that's why we built Community Sift with the optimal developer experience in mind. Learn how your product interacts with Community Sift in three simple steps.
Step 1: Call our API
Luckily, you do not have to install anything to get started with Community Sift. Instead, we provide you with an access key and a secure RESTful API, where you send the user id and their message to the Community Sift server in a simple JSON request via HTTPS.
Step 2: Community Sift reviews the messages
Community Sift processes incoming user-generated messages in real-time. The system evaluates messages on a sliding scale of risk, and may attach labels like topic(s) (e.g. bullying, sexting, personal information) where applicable. Our system also tracks and adjusts user reputation based on chat behaviour, meaning a user's reputation will influence whether they gain or lose trust in the system. You can configure Community Sift to change a user's filtration levels automatically as they move between trusted or untrusted statuses.
Each Community Sift instance is set up to match the policies, terms, and rules of your company.
Step 3: Community Sift returns results
You decide what to do next. Community Sift returns all messages with their assigned risks and topics, enabling you to make a data-driven decision about what to do with the message and how to manage the user.
We send results back as TRUE (recommended action: allow) or FALSE (recommended action: reject) in accordance with your settings, and attach any necessary events like flooding, muting, banning, or trust level changes.
Community Sift returns this data in a clean JSON format via secure HTTPS. Your servers just have to process the response and take appropriate action. You are in control.
Check out Community Sift in action with our BrowserQuest demo install.
Sounds pretty simple right? We have done (almost) all the work, so there are just a few things you should have in place to help the setup process.
How to make the web request:
We are using a standard REST-based interface. You should use a standard REST library for your server and implement the commands against it. Some key elements you should look for:
- The library needs to allow you to send and receive JSON requests/responses. You should set the "Connection: Keep-Alive" header so you can increase your speeds.
- You should send all commands asynchronously to ensure that you do not block other commands and inadvertently slow down your server.
- You need to ensure you clean all the fields on both the URL and JSON.
We can roll out Community Sift over a period that best suits your needs. This way you can budget your dev resources against sprint cycles:
- Step 1: Enable ability to make REST calls using any standard library with user_id, message, channel_id
- Step 2: Enable ability to say when users join/leave a chat room (if applicable)
- Step 3: If a message is inappropriate, enable the potential to drop it, replace it, or take intelligent action with the user (such as warning or sanctioning them)
We hope you've gained a better understanding of how you can integrate your product with our service.
Get started with Community Sift today!