Send test event

  2 minute read  

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

cURL

curl --request POST 'https://www.digicert.com/services/v2/webhook/test-endpoint' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "endpoint": "https://webhook.example.com/endpoint"
}'

200 OK

// No content

Request parameters

NameOpt/ReqTypeDescription
endpointrequiredstringEndpoint URL where your webhook listener is hosted.
secretoptionalstringSecret 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

StatusCodeDescription
400webhook_invalid_endpointThe provided endpoint is not valid. Make sure the endpoint begins with https:// and try again.
400webhook_endpoint_errorThe 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.