Checkr Plugin

Checkr is a modern, RESTful API-driven background screening service. This is a documentation for Bubble's Checkr Plugin

Bubble plugin page

How to get started

Getting the plugin ready

1. Login to or create a Checkr account

2. Go to dashboard > Account Settings > Developer Settings

3. View Mode select which the environment Test or Live

4. Under API Keys, create a secret API key

5. Copy the secret API key

6. Go back to your Bubble editor > Plugins > Checkr

7. Paste it into the Username field

   1. if it's a test key add it to the Username - dev

   2. If it's a live key add it to the Username

8. Leave the password field blank

Creating a webhook

Use webhooks to receive updates on objects created with the API and to kick off additional workflows based on these events. Each time an event that you subscribed to occurs, Checkr submits a POST request to the designated webhook URL with information about the event.

How to configure a webhook

1. Login to or create a Checkr account

2. Go to dashboard > Account Settings > Developer Settings

3. New Webhook add your Bubble backend workflow URL

4. Click "Add"

5. Under Webhook subscriptions select the events types that you want to receieve ex. Check "All report updates" if you would like to receive report related events

How to use it

1. Use the Create A Candidate action then store the candidate id

2. Store the candidate id to use with other actions

3. To create a report, use the Create a Report action

4. On the create a report action type the report package and candidate id