# Webhooks

The webhook is called when the status of a check changes.

# Webhook details

Here is an example of the status changing to CRITICAL:

{
  "orgId": "ndIjUtaR06QzktqQSli3hs9O1Zs1",
  "checkName": "Login Check",
  "message": "The login succeeded",
  "description": "A check that monitors that logins to the site succeeds",
  "previousStatus": "OK",
  "status": "CRITICAL",
  "timestamp": "2022-06-18T06:52:54.304283Z"
}

The status and previousStatus fields can have one of the following values:

  • OK
  • CRITICAL

orgId is the identifier of your Checkson organization.

The timestamp field contains the time in ISO 8601 format when the change in status occurred.

The request is sent with a POST request. It has the following headers:

  • Content-Type - application/json; charset=utf-8

# Create the notification channel

To configure a webhook simply add a notification channel of type Webhook.

Choose a name, select "Webhook" as the type and enter the URL that Checkson should send the request to.

When you click 'Create' the new notification channel has been created. You can now use this channel for checks.

You can trigger an example webhook using the 'Send test notification' button.