List webhook topics

What this is for: this is the reference list of event types you can point a webhook at. "Topic" is this API's name for one such event type (e.g. contact.created) — the value you put in topics when calling POST /v4/webhooks. Call this endpoint first, before creating any webhook, to see exactly which event types exist and what each one's data payload looks like; it's the single source of truth, so build your UI or integration against this response rather than a hardcoded list, since the catalogue grows over time.

Nine topics exist today, all describing things commons-api itself writes (contacts and orders). Two notable absences, both deliberate:

contact.subscribed does not exist. Only contact.unsubscribed does. There was no single write path that could honestly mean "opted in to marketing" as opposed to "added to list X" — see contact.list_added for the general case.

cart.abandoned does not exist yet. It requires detecting the absence of a checkout, which needs a scheduled sweep rather than a write to hook — not yet implemented.

This endpoint requires no special permission beyond a valid API key and returns the same catalogue regardless of website — the topic list itself isn't website-scoped, only your subscriptions to it are.

{"topics": [{"name": "contact.created", "summary": "A new contact was created.", "exampleData": {"contact": {"contactId": "0f3e2b1a-...", "clientContactId": "1042", "email": "jan@example.cz"}}}, {"name": "contact.unsubscribed", "summary": "A contact was removed from a subscription list (or unsubscribed from all).", "exampleData": {"contact": {"contactId": "0f3e2b1a-...", "clientContactId": "1042", "email": "jan@example.cz"}, "lists": [{"id": 7, "name": "Newsletter"}]}}, {"name": "order.cancelled", "summary": "An order's state changed to cancelled.", "exampleData": {"order": {"orderId": "9c1a...", "clientOrderId": "ORD-2026-0042", "state": "cancelled"}}}]}

Request

Responses