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.

{
  "id": "whc_7uCODm8JFmZyov9jL8QO",
  "url": "http://3385edbc219e.ngrok.io",
  "key": "2bfce877d2e64ea6a8dd45ffb2ce897eb4d97485"
}

Attribute

Description

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.