Skip to main content
POST
Create a webhook encryption key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

endpoint_id
string
required

The ID of the webhook endpoint to create the encryption key for (e.g. whe_...).

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Body

application/json
key_id
string
required

The key identifier to use as kid in the JWE header.

Required string length: 1 - 128
jwk
object
required

The public JWK for encrypting webhook payloads.

algorithm
enum<string>
required

The JWE algorithm to use for webhook delivery.

Available options:
RSA-OAEP-256
key_type
enum<string>
required

The JWK key type for webhook delivery.

Available options:
RSA

Response

Successful operation.

data
object
required
error
null
required