Create a new Webhook

Request

Creates a new Webhook resource. An account can have a maximum of 2 webhooks.

Any webhook URL that fails to accept with a 2XX status code at least one request over a period of 60 days will be removed automatically - e.g. webhooks failing for 100% of the requests during 60 or more days.

Security

basic_auth

Bodyapplication/jsonrequired

include_objectboolean

When true, the webhook event payload will include the related object.

webhook_urlstringrequired

The URL which receives the webhook event payload. This must be an HTTPS or an AWS SNS URL. For more information, see Supported Webhook URLs section.

Example:"https://example.com"

liveboolean

When 'true', the webhook is for the live environment.

Example:true

curl -i -X POST \
  -u '<username>:<password>' \
  https://docs.checkr.com/_mock/apis/openapi/webhooks \
  -H 'Content-Type: application/json' \
  -d '{
    "include_object": true,
    "webhook_url": "https://example.com",
    "live": true
  }'

Responses

Webhook details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"webhook"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/webhooks/e44aa283528e6fde7d542194"

account_idstringread-only

The account associated with the webhook.

Example:"8e122cc56b8fa82d33c6118a"

application_idstringread-only

The application associated with the webhook.

Example:null

include_objectboolean

When true, the webhook event payload will include the related object.

webhook_urlstringrequired

The URL which receives the webhook event payload. This must be an HTTPS or an AWS SNS URL.

Example:"https://example.com"

created_atstring, (date-time)read-only

Time at which the webhook was created.

Example:"1939-09-01T12:21:00Z"

deleted_atstring or null, (date-time)read-only

Time at which the webhook was deleted.

Example:null

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "webhook",
  "uri": "/v1/webhooks/e44aa283528e6fde7d542194",
  "account_id": "8e122cc56b8fa82d33c6118a",
  "application_id": null,
  "include_object": true,
  "webhook_url": "https://example.com",
  "created_at": "1939-09-01T12:21:00Z",
  "deleted_at": null
}