Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

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"
Response200
{
  "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
required

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
required

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
required

The certificate in use. null until you upload one.

Show child attributes
signing_request
nullable object
required

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

Show child attributes
signing_request.csr
string
required

The PEM-encoded PKCS #10 certificate signing request.

signing_request.created_at
string
required

When we created the signing request.

updated_at
nullable string
required

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

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief