Skip to main content

List webhooks

GET https://www.digicert.com/services/v2/webhook

Use this endpoint to get information about your CertCentral webhooks.

Note

Because a CertCentral account can only have one webhook, this endpoint returns a webhooks list with a single webhook object.

Example requests and responses

Response parameters

Name

Type

Description

webhooks

array

List of objects with information about the webhooks in your CertCentral account.

.. id

number

Webhook ID.

.. endpoint

string

Endpoint URL where your webhook listener is hosted.

.. secret

string

Secret key value that DigiCert sends in the X-WEBHOOK-KEY request header with webhook events. For increased security, configure your webhook listener to validate the X-WEBHOOK-KEY value in each received event.

Omitted if no secret is configured for the webhook.

.. events

array of strings

List of events CertCentral sends to the endpoint for this webhook.

Possible values: See CertCentral event types.

.. status

string

Webhook status (pending, active, inactive).

webhook_settings

object

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

.. webhook_notification_frequency

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 includes one or more of the following numbers:

  • 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

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

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

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_account

No webhook exists for the account.