---
updatedAt: 2026-08-18T17:22:08.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# The webhook config object

Defines the URL to which Check will send webhook requests for events that pertain to your organization.

When you create a webhook config, we will automatically start sending webhook requests to the URL you pass us. Each webhook config also has a `key`, which we use to create a signature that you can recreate on the receiving side to verify the authenticity of our requests.

```json Sample webhook config object
{
  "id": "whc_7uCODm8JFmZyov9jL8QO",
  "url": "http://3385edbc219e.ngrok.io",
  "key": "2bfce877d2e64ea6a8dd45ffb2ce897eb4d97485",
  "active": true,
  "api_version": null
}
```

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `id`  
        _string_
      </td>

      <td>
        Unique identifier for the webhook config.
      </td>
    </tr>

    <tr>
      <td>
        `url`  
        _string_
      </td>

      <td>
        URL where webhook events will be sent.
      </td>
    </tr>

    <tr>
      <td>
        `key`  
        _string_
      </td>

      <td>
        Key that Check will use to generate the `X-Signature` header in webhook requests.
      </td>
    </tr>

    <tr>
      <td>
        `active`  
        _boolean_
      </td>

      <td>
        Indicates whether the config is active. If false, Check will not send webhook events to this URL.
      </td>
    </tr>

    <tr>
      <td>
        `api_version`  
        _string, nullable_
      </td>

      <td>
        API version used to serialize webhook event payloads for this config. Accepts any supported Check API version label (for example, `2025-01-01`). When `null`, payloads follow your account's default API version.
      </td>
    </tr>
  </tbody>
</Table>