Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Partner webhooks notify your integration when important partner API events happen. Webhook subscriptions are partner-level resources under:
https://api.prod.commenda.io/api/v1/partner/webhook-subscriptions
They are not scoped to a single customer or incorporation. A subscription receives events for your resources when its eventTypes includes the emitted event.

Supported events

Event typeTrigger
INCORPORATION_ISSUE_CREATEDCommenda creates a partner-visible issue for an incorporation.
INCORPORATION_ISSUE_RESOLVEDCommenda resolves a partner-visible issue.
Commenda may add additional event types in future API updates.

Delivery behavior

Webhook delivery is asynchronous. Commenda retries failed deliveries. Your endpoint should:
  • Use HTTPS.
  • Be reachable on a public address.
  • Return a 2xx response within 10 seconds.
  • Treat events as at-least-once delivery and dedupe by eventId.
Commenda stores only a bounded snippet of partner response bodies for delivery diagnostics.

Signatures

Each delivery includes these headers:
HeaderDescription
Commenda-Webhook-IdStable event id. Use this for idempotency.
Commenda-Webhook-TimestampISO timestamp generated for this delivery.
Commenda-Webhook-SignatureHMAC SHA-256 signature in the form v1=<hex_digest>.
The signature is computed with the subscription secret over:
{Commenda-Webhook-Timestamp}.{raw_request_body}
The full secret is returned only when you create the subscription. Later reads return secretPreview.

Incorporation issue payload

{
  "eventId": "evt_incorporation_issue_created_issue_123",
  "eventType": "INCORPORATION_ISSUE_CREATED",
  "createdAt": "2026-04-25T21:00:00.000Z",
  "data": {
    "customerId": 77,
    "incorporationId": "0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91",
    "issue": {
      "id": "issue_123",
      "code": "DOCUMENT_INVALID",
      "message": "The passport scan for Jane Founder is unreadable. Please upload a clearer scan.",
      "status": "ACTIVE",
      "scope": {
        "type": "PARTICIPANT_DOCUMENT",
        "participantId": "participant_123",
        "documentKind": "PASSPORT_SCAN",
        "fileId": 456
      },
      "createdAt": "2026-04-25T20:58:00.000Z",
      "updatedAt": "2026-04-25T20:59:00.000Z"
    }
  }
}

Correction cycle semantics

Resolved incorporation issues are not reopened. If Commenda needs another correction after a previous issue was resolved, a new issue is created and a new INCORPORATION_ISSUE_CREATED event is emitted.