Webhooks V2

Update an mTLS configuration

Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a 400.

Replacing signedCert switches every webhook and OAuth credentials set using this configuration over to the new certificate in one write, and the private key it was issued for is re-derived from the certificate. A replacement that was not issued for a private key this workspace holds is rejected with a 400.

Sending name: null removes the label.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

patch/webhooks_settings/mtls/{webhookMtlsId}

Request

Path parameters

webhookMtlsIdstring uuid required
Example:44fcead0-7053-4831-a53a-df7fb90d440f

The unique identifier of the mTLS configuration

Request body

namestring nullable

A new label for this mTLS configuration, or null to remove it. Letters, digits and spaces only.

signedCertstring

A replacement signed certificate PEM. Every webhook and OAuth credentials set using this configuration switches to it, and the private key it was issued for is re-derived from the certificate.

Example request

{
  "name": "Production gateway 2027",
  "signedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
}

Response

The updated mTLS configuration

idstring uuid required

The unique identifier of the mTLS configuration, to be set as webhookMtlsId on a webhook or on OAuth credentials.

namestring

The label given to this mTLS configuration.

signedCertstring required

The signed client certificate PEM.

expiresAtinteger required

When the certificate itself expires, in milliseconds since the epoch.

createdAtinteger required

When the certificate was uploaded, in milliseconds since the epoch.

updatedAtinteger required

When this configuration was last changed, in milliseconds since the epoch. Differs from createdAt once the certificate has been replaced or the configuration renamed.

Example response

{
  "id": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "name": "Production gateway 2026",
  "signedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "expiresAt": 1726108200000,
  "createdAt": 1694572200000,
  "updatedAt": 1726108200000
}

Changes

No recorded changes to this operation across all 1 revision of this API.