Skip to main content
DELETE
TypeScript

Path Parameters

webhookMtlsId
string<uuid>
required

The unique identifier of the mTLS configuration

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

Query Parameters

forceDelete
boolean
default:false

Delete the configuration even while webhooks still reference it, detaching those webhooks instead of refusing. Leave it unset, or false, to get a 409 Conflict whenever anything still references the configuration.

Response

The deleted mTLS configuration, plus the ids of any webhooks that were detached from it

The deleted mTLS configuration, plus the ids of any webhooks the delete detached from it. Webhooks are only detached by forceDelete=true; without it a delete is refused with 409 while anything still references the configuration.

id
string<uuid>
required

The unique identifier of the mTLS configuration, to be set on a webhook.

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

signedCert
string
required

The signed client certificate PEM.

Example:

"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"

expiresAt
integer<int64>
required

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

Example:

1726108200000

createdAt
integer<int64>
required

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

Example:

1694572200000

updatedAt
integer<int64>
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:

1726108200000

detachedWebhookIds
string<uuid>[]
required

Webhooks whose webhookMtlsId was cleared. The webhooks themselves are not deleted and keep delivering, just without a client certificate. Empty unless forceDelete=true detached something.

Example:
name
string

The label given to this mTLS configuration.

Example:

"Production gateway 2026"