Create webhook

To create a webhook, you must host a webhook listener at an endpoint URL you control. You use this endpoint to create the webhook in your CertCentral account.

After you create a webhook:

1. Send a test event to ensure CertCentral can communicate with your webhook listener.
2. Complete a verification challenge to demonstrate you have access to data the endpoint receives. To complete the challenge using the API, use the Send challenge token and Verify challenge token API endpoints.
3. Activate the webhook to start receiving certificate issuance events.

For more information about webhooks in CertCentral, see CertCentral webhooks.

Usage and limitations

• An update from a CertCentral webhook is called an event. CertCentral sends webhook events as JSON-formatted data objects to an endpoint URL you control.
• You can only create one webhook in your CertCentral account. After creating a webhook, you can change the endpoint URL where you listen for webhook events by using the Update webhook endpoint API.

Example requests and responses

cURL

curl --request POST 'https://www.digicert.com/services/v2/webhook' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "endpoint": "https://webhook.example.com/endpoint",
  "events": [
    "organization_revalidation_notice",
    "domain_expired",
    "domain_revalidation_notice",
    "certificate_revoked",
    "order_rejected",
    "organization_expired",
    "organization_validated",
    "domain_validated",
    "certificate_issued"
  ],
  "webhook_settings": {
    "instant_issue_webhook_notification": "1",
    "webhook_notification_frequency": [90,60,30,7,0,-7],
    "webhook_send_certificate_chain": "1",
    "webhook_send_instant_issued_certificate_chain": "1"
  }
}'

201 Created

{
  "webhook_id": 1234
}

Request parameters

Response parameters

Error cases