Sign inGet Started

Get the webhook client certificate

GET
/v1/workspace/webhook-client-certificate
curl -X GET "https://us1.platform.bird.com/v1/workspace/webhook-client-certificate" \
  -H "Authorization: Bearer $TOKEN"
Reactie200
{
  "state": "disabled",
  "crl_check": "disabled",
  "certificate": {
    "subject": "CN=bird-webhooks,O=Example Inc.",
    "issuer": "CN=Example Client CA,O=Example Inc.",
    "serial_number": "4f2a91c0d3",
    "fingerprint_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  },
  "signing_request": {
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIB...\n-----END CERTIFICATE REQUEST-----\n"
  }
}

Returns the client certificate that we present on webhook deliveries of your workspace, its state and any waiting signing request. Realtime delivers realtime.* events without the certificate. Connector endpoints and MCP Events subscriptions never present it.

Response Payload

state
string
verplicht

Whether client certificates are off (disabled), checked while the previous behavior stays available (evaluating), or required (enforced).

Possible values: disabled, evaluating, enforced

crl_check
string
verplicht

How a certificate chain is checked against the certificate revocation list (CRL) that each certificate names. With full_chain, the leaf certificate and each intermediate certificate below the trusted root are checked. A certificate that names no CRL is not checked.

Possible values: disabled, full_chain

certificate
nullable object
verplicht

The certificate in use. null until you upload one.

Onderliggende attributen tonen
certificate.subject
string
verplicht

The distinguished name of the certificate.

certificate.issuer
string
verplicht

The distinguished name of the certificate authority that signed it.

certificate.serial_number
string
verplicht

The serial number, in lowercase hexadecimal.

certificate.fingerprint_sha256
string
verplicht

The SHA-256 fingerprint of the certificate, in lowercase hexadecimal.

certificate.not_before
string
verplicht

Start of the validity period.

certificate.not_after
string
verplicht

End of the validity period.

signing_request
nullable object
verplicht

The signing request that waits for a signed certificate. null when none waits.

Onderliggende attributen tonen
updated_at
nullable string
verplicht

When the certificate or its state last changed. null until the first change.

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.