Skip to main content

Webhooks

Signed HTTP notifications sent when events occur.

CommandHTTPDescription
webhooks listGET /v1/webhooksList webhooks
webhooks createPOST /v1/webhooksCreate webhook
webhooks getGET /v1/webhooks/{id}Get webhook details
webhooks updatePATCH /v1/webhooks/{id}Update webhook
webhooks deleteDELETE /v1/webhooks/{id}Delete webhooks (soft delete)
webhooks rotate-secretPOST /v1/webhooks/{id}/rotate-secretRotate the signing secret

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits the fields that come back — worth using on every list/get to save context. See Global flags for the full reference.

# List webhooks
kobana kadu webhooks list --fields "id"

# Create webhook
kobana kadu webhooks create \
--json '{"label": "LABEL", "url": "https://example.com", "auth": "basic"}'

# Get webhook details
kobana kadu webhooks get --params '{"id": "WEBHOOK_ID"}'

# Update webhook
kobana kadu webhooks update --params '{"id": "WEBHOOK_ID"}'

# Delete webhooks (soft delete)
kobana kadu webhooks delete \
--params '{"id": "WEBHOOK_ID"}' \
--dry-run

# Rotate the signing secret
kobana kadu webhooks rotate-secret \
--params '{"id": "WEBHOOK_ID"}' \
--dry-run

Next steps​