Skip to main content
POST
Create webhook subscription
Creates a partner-level webhook subscription. The response includes the full secret exactly once. Store it securely and use it to verify webhook signatures. Later reads return only secretPreview. Webhook URLs must use HTTPS and must be reachable on public addresses.

Example

Authorizations

x-api-key
string
header
required

Body

application/json
url
string<uri>
required

HTTPS webhook URL reachable on a public address.

Example:

"https://partner.example.com/commenda/webhooks"

eventTypes
enum<string>[]
required
Minimum array length: 1

Partner webhook event type. Commenda may add additional event types in future API updates.

Available options:
INCORPORATION_ISSUE_CREATED,
INCORPORATION_ISSUE_RESOLVED

Response

Webhook subscription created successfully

webhookSubscription
object
required