Skip to main content
POST
/
partner
/
webhook-subscriptions
Create webhook subscription
curl --request POST \
  --url https://api.prod.commenda.io/api/v1/partner/webhook-subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://partner.example.com/commenda/webhooks",
  "eventTypes": [
    "incorporation.issue.created",
    "incorporation.issue.resolved"
  ]
}
'
{
  "webhookSubscription": {
    "id": "whsub_123",
    "url": "https://partner.example.com/commenda/webhooks",
    "eventTypes": [
      "incorporation.issue.created"
    ],
    "status": "active",
    "secretPreview": "whsec_...c123",
    "createdAt": "2026-04-25T21:00:00.000Z",
    "secret": "whsec_abc123"
  }
}
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

curl --request POST \
  --url 'https://api.prod.commenda.io/api/v1/partner/webhook-subscriptions' \
  --header 'content-type: application/json' \
  --header 'x-api-key: <partner_api_key>' \
  --data '{
    "url": "https://partner.example.com/commenda/webhooks",
    "eventTypes": [
      "incorporation.issue.created",
      "incorporation.issue.resolved"
    ]
  }'

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