Send test event

POST https://www.digicert.com/services/v2/webhook/test-endpoint

Use this endpoint to send a test event to a webhook endpoint. The test event verifies CertCentral can communicate with the endpoint where your webhook listener is hosted. Your endpoint should respond to the test event with an HTTP status code of 200 OK. The test event has this format:

{
  "event": "test_webhook_endpoint"
}

Example requests and responses

Request parameters

Name	Opt/Req	Type	Description
endpoint	required	string	Endpoint URL where your webhook listener is hosted.
secret	optional	string	Secret key value. Must be at least 32 characters. If provided, the test event DigiCert sends to your endpoint includes an `X-WEBHOOK-KEY` request header. This request header contains your secret key value. For increased security, configure your webhook listener to validate the `X-WEBHOOK-KEY` value in each received event. If no `secret` is provided, DigiCert omits the `X-WEBHOOK-KEY` request header from the test event.

Name

Opt/Req

Type

Description

endpoint

required

string

Endpoint URL where your webhook listener is hosted.

secret

optional

string

Secret key value. Must be at least 32 characters.

If provided, the test event DigiCert sends to your endpoint includes an X-WEBHOOK-KEY request header. This request header contains your secret key value. For increased security, configure your webhook listener to validate the X-WEBHOOK-KEY value in each received event.

If no secret is provided, DigiCert omits the X-WEBHOOK-KEY request header from the test event.

Error cases

Status	Code	Description
400	webhook_invalid_endpoint	The provided endpoint is not valid. Make sure the endpoint begins with https:// and try again.
400	webhook_endpoint_error	The provided endpoint is not responding or accepting requests. Make sure your webhook listener is configured correctly and try again. For more information, see Webhook endpoint requirements.

In this section: