Docs
API 1.39
Status
Objects

Webhook

The Webhook object of the Kaabist API.

FieldTypeRequiredDescription
idstringyespattern ^whk_[0-9a-hjkmnp-tv-z]{26}$
object"webhook"yes
urlstring (uri)yes
eventsstringyesmin items 1
mode"live", "test", "both"yes
format"standard", "discord", "slack"yes
status"active", "disabled"yes
descriptionstring or nullyes
disabled_reasonstring or nullyes
previous_secret_expires_atstring or null (date-time)yes
created_atstring (date-time)yes

#Example

{
  "id": "whk_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "object": "webhook",
  "url": "https://hooks.acme.test/kaab",
  "events": [
    "job.*",
    "credits.low"
  ],
  "mode": "both",
  "format": "standard",
  "status": "active",
  "description": null,
  "disabled_reason": null,
  "previous_secret_expires_at": null,
  "created_at": "2026-09-18T10:00:00Z"
}

Was this page helpful?