List webhooks

2 minute read

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

cURL

curl --request GET 'https://www.digicert.com/services/v2/webhook' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json'

200 OK

{
  "webhooks": [
    {
      "id": 12345,
      "endpoint": "https://www.example.com/my/webhook",
      "events": [
        "organization_revalidation_notice",
        "domain_expired",
        "domain_revalidation_notice",
        "certificate_revoked",
        "order_rejected",
        "organization_expired",
        "organization_validated",
        "domain_validated",
        "certificate_issued"
      ],
      "status": "active",
      "webhook_settings": {
        "webhook_notification_frequency": [
          90,
          60,
          30,
          7,
          0,
          -7
        ],
        "instant_issue_webhook_notification": "1",
        "webhook_send_certificate_chain": "1",
        "webhook_send_instant_issued_certificate_chain": "1"
      }
    }
}

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:
.. 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