Kalpana Docs
Resources

List event types

The events an endpoint can subscribe to, and the formats it can send.

GET /api/webhooks/event-types

Requires webhooks:read.

NameTypeRequiredDescription
workspacestringYesWorkspace slug or id.
curl "https://app.kalpana.one/api/webhooks/event-types?workspace=acme" \
  --header "x-api-key: $KALPANA_API_KEY"

Response

{
  "allEvents": "*",
  "eventTypes": [
    {
      "type": "batch.completed",
      "description": "Every job of a batch run finished; carries the succeeded, failed and cancelled counts."
    },
    {
      "type": "job.completed",
      "description": "A render job finished; carries the creative, its download link and the row that produced it."
    }
  ],
  "formats": ["json", "slack", "discord", "google_chat"]
}

allEvents is the value that subscribes an endpoint to every event, including ones added later. The payload of each event is in Receiving webhooks.

Was this page helpful?

Updated 4 Nov 2026

On this page