Skip to content
/
Delete a Webhook

Delete a Webhook

Request

Deletes the existing Webhook corresponding to the input ID.

Security
basic_auth
Path
idstringrequired

ID of the Webhook.

curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/webhooks/${id}'

Responses

Webhook was successfully deleted

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:"1945-09-02T04:40:00Z"
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": "1945-09-02T04:40:00Z"
}
© Checkr, Inc.