# Checkr Plugin

{% hint style="info" %}
[Bubble plugin page](https://bubble.io/plugin/checkr-1566436077146x670483864007213000)
{% endhint %}

## 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

<figure><img src="/files/R6lsfmn0Tr8QFfRlgvZo" alt=""><figcaption></figcaption></figure>

### 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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.inova.us/v1/checkr-plugin.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.