For Developers

Integration types

Step 1

PeerBoard supports two different modes of integration:

Light integration

When you run your instance on our domain or your custom domain and simply link to it from your website, ideally through a url with a signed user session so we can automatically log your members in.

Example: our own community.peerboard.com

Deep integration

Our unique offering that we've put a lot of effort to create. It allows you to put PeerBoard right into your product (instead of next to it, like with Light) and make it seamlessly blend into your brand and user experience. Read more about it here.

Example: smartcat.com/community

We generally recommend using deep integrations for experienced partners with internal development teams and light for when you need to launch quickly and with minimal effort. Note that we also support different plugins to do the job of integrating deeply for you.

Single Sign-On

Single Sign-On (SSO) is a process of automatically passing your member session to another application, PeerBoard in this case. You create a unique link to your PeerBoard community by signing user information for your logged in member with your community secret key. When a member opens this link, we decode the session information and automatically log in this member on our end. If needed, we create a new account on the fly.

Time to implement: one hour of engineering time to launch quickly.

Read more in our guide



Step 2

Sync data with APIs

In either of the scenarios above, you may want to keep the data on PeerBoard's end updated. Automatic member registration on your signup, email change propagation and consistent account deactivation are the things we recommend implementing to make sure your member experience is smooth. You can also use our APIs to manage community settings, member data, group membership and many other things. For that, we have a collection of REST endpoints to extend capabilities provided by our UI and enable some important programmatic logic.

Time to implement: one hour of engineering time to make user experience fully consistent.

Integration types

Ready to integrate?