The webhook config object

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

A webhook config tells Check where to send webhooks and which events to send. Use the event_types attribute to choose event types when creating or updating a config through the API; call List event types to see which values are selectable at your API version. A new webhook config defaults to an empty event_types list, so Check won't send it any webhooks until you add types. Set event_types to null to receive every event type. See Managing webhook configs and deliveries for details.

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.

{
  "id": "whc_7uCODm8JFmZyov9jL8QO",
  "url": "http://3385edbc219e.ngrok.io",
  "key": "2bfce877d2e64ea6a8dd45ffb2ce897eb4d97485",
  "active": true,
  "api_version": null,
  "event_types": ["employee.created", "payroll.updated"]
}
AttributeDescription
id
string
Unique identifier for the webhook config.
url
string
URL where webhook events will be sent.
key
string
Key that Check will use to generate the X-Signature header in webhook requests.
active
boolean
Indicates whether the config is active. If false, Check will not send webhook events to this URL.
api_version
string, nullable
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.
event_types
array of strings, nullable
Event types this webhook config receives. An empty list receives none; null receives every event type. See List event types for selectable values.