Skip to main content

Update webhook

PUT https://www.digicert.com/services/v2/webhook/{{webhook_id}}

Use this endpoint to update a CertCentral webhook.

Note

When you change the endpoint for a webhook, you must verify the endpoint before it can receive webhook events. After changing the endpoint, complete a verification challenge and activate the webhook.

Example requests and responses

Path parameters

Name

Opt/Req

Type

Description

webhook_id

required

number

ID of the webhook to update.

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

secret

optional

string

Secret key value. Must be at least 32 characters.

To add or change a secret key, provide a new secret value in your request. To remove the secret key from a webhook, submit an empty string ("") as the value of the secret parameter. To leave the existing secret key unchanged, omit the secret parameter from your request.

If a secret is configured for the webhook, events DigiCert sends to your endpoint include 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 configured for the webhook, DigiCert omits the X-WEBHOOK-KEY request header from events sent to your webhook listener.

events

optional

array of strings

List of event types the webhook is subscribed to.

To change the webhook endpoint without changing the events the webhook is subscribed to, omit the events request parameter.

Allowed values: See Webhook events.

webhook_settings

optional

object

Optional settings for customizing certificate issued, validation expired, and revalidation notice events.

.. instant_issue_webhook_notification

optional

array of integers

Array of values that determine when you receive notifications for organization_expired, organization_revalidation_notice, domain_expired, and domain_revalidation_notice events. The webhook_notification_frequency array should include one or more of the following numbers (order doesn't matter):

  • 90: 90 days before event

  • 60: 60 days before event

  • 30: 30 days before event

  • 7: Seven days before event

  • 0: Day of event

  • -7: Seven days after event

.. instant_issue_webhook_notification

optional

string

If 0, CertCentral sends certificate_issued events only for certificates that are not issued the instant the order is created. If 1, CertCentral sends certificate_issued events every time a certificate is issued, including certificates issued immediately.

.. webhook_send_certificate_chain

optional

string

If 1, certificate_issued events for public and private TLS/SSL certificates include the certificate chain for certificates that are not not issued the instant the order is created. Otherwise, 0 (default).

Learn more: Customize certificate issued events

.. webhook_send_instant_issued_certificate_chain

optional

string

If 1, certificate_issued events for public and private TLS/SSL certificates include the certificate chain for certificates issued the instant the order is created. Otherwise, 0 (default).

Learn more: Customize certificate issued events

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.