Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Checkr Webhooks API

Event notification subscriptions.

Checkr Webhooks API is one of 14 APIs that Checkr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.checkr.com/v1, https://api.checkr-staging.com/v1.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.checkr.com/v1
Authentication
HTTP Basic
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Checkr Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth with your secret API key as the username and an empty password. Checkr Partner integrations authenticate on behalf of customer accounts using O…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 4

Event notification subscriptions.

GET
/webhooks
List webhooks
listWebhooks → 200
POST
/webhooks
Create a webhook
createWebhook body → 201
GET
/webhooks/{id}
Retrieve a webhook
getWebhook 1 param → 200
DELETE
/webhooks/{id}
Delete a webhook
deleteWebhook 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Webhook (6 properties), WebhookCreate (3 properties). Each schema is shown below with its type and property counts.

WebhookCreate
object
3 properties 1 required
Webhook
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkr-webhooks-api-openapi.yml Raw ↑

Other APIs Checkr publishes across the network.

Checkr Account API
Checkr Adverse Actions API
Checkr Candidates API
Checkr Continuous Checks API
Checkr Documents API
Checkr Geos API
Checkr Invitations API
Checkr Nodes and Hierarchy API
Checkr Packages API
Checkr Reports API
Checkr Screenings API
Checkr Subscriptions API