Create a new webhook

Creates a new webhook that will be called when the specified event is triggered.

Request
Request Body schema: application/json
type
required
string

The event type that should trigger this webhook.

Enum: "VerificationCompleted" "ExportCompleted" "LicenseExpiresSoon" "LicenseExpired" "LicenseChanged" "DatasetScanCompleted" "LicenseStatusChanged" "ProviderStatusChanged" "ProviderProfileImportCompleted" "CredentialingRequestChanged" "GenerateReport" "DatasetScanMatchesChanged" "NpdbUpdateRequestRejected"
url
required
string <uri>

The URL we will make an HTTP POST request to when an event of type occurs.

secret
string

An optional secret which will be passed in the X-Secret header to the webhook callback URL.

allowInsecureUrl
boolean

Set to true to allow insecure callback URLs such as URLs without SSL or URLs with self signed certificates.

includeSensitiveInfo
boolean

If set to false, the sensitive info will be masked in the webhook payload. The default value is true.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Server Error

post/webhooks
Request samples
application/json
{
  • "type": "VerificationCompleted",
  • "url": "http://example.com",
  • "secret": "string",
  • "allowInsecureUrl": true,
  • "includeSensitiveInfo": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "VerificationCompleted",
  • "url": "http://example.com",
  • "allowInsecureUrl": true,
  • "includeSensitiveInfo": true
}