Create webhook
POST https://www.digicert.com/services/v2/webhook
Use this endpoint to create a webhook in your CertCentral account.
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:
Send a test event to ensure CertCentral can communicate with your webhook listener.
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.
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.
CertCentral sends a webhook event each time DigiCert issues a certificate in your account*. For a description of the event format, see Webhooks – Certificate issuance events.
CertCentral sends certificate issuance events for all certificate types.
Note
*CertCentral only sends certificate issuance events for certificates that aren’t immediately issued.
Example requests and responses
Request parameters
Name | Opt/Req | Type | Description |
|---|---|---|---|
endpoint | required | string | Endpoint URL where your webhook listener is hosted. Must begin with https://. Learn more: Webhook endpoint requirements |
Response parameters
Name | Type | Description |
|---|---|---|
webhook_id | number | ID of the new webhook. |
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_configured_already | A webhook already exists in the CertCentral account. To change the endpoint URL where you listen for webhook events, use the Update webhook endpoint API. |
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. |