Sign inGet Started
Mulai sekarang
Panduan
Referensi API
SDK
CLI
Basis Pengetahuan
Changelog

Upload the webhook client certificate

POST
/v1/workspace/webhook-client-certificate/certificate
curl -X POST "https://us1.platform.bird.com/v1/workspace/webhook-client-certificate/certificate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "certificate_chain": "-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----\n"
  }'
Respons200
{
  "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"
  }
}

Uploads the certificate that your certificate authority signed for the waiting signing request. It replaces the certificate in use. Test sends use the new certificate at once. Deliveries can keep presenting the previous one for up to a few minutes, so keep accepting both until then. Without a waiting signing request, this returns 409. A certificate that does not match the key of the signing request, has no clientAuth extended key usage or is outside its validity period returns an error. So does an intermediate certificate that is not a CA certificate in its validity period that signed the certificate before it. If webhook mTLS is not enabled for this workspace, this returns 422.

Payload Permintaan

certificate_chain
string
wajib

PEM-encoded certificates, the signed certificate first, then any intermediate certificates.

Payload Respons

state
string
wajib

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
wajib

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
wajib

The certificate in use. null until you upload one.

Tampilkan atribut turunan
certificate.subject
string
wajib

The distinguished name of the certificate.

certificate.issuer
string
wajib

The distinguished name of the certificate authority that signed it.

certificate.serial_number
string
wajib

The serial number, in lowercase hexadecimal.

certificate.fingerprint_sha256
string
wajib

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

certificate.not_before
string
wajib

Start of the validity period.

certificate.not_after
string
wajib

End of the validity period.

signing_request
nullable object
wajib

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

Tampilkan atribut turunan
updated_at
nullable string
wajib

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

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Dapatkan ringkasan implementasi