kf webhook
Subscribe to, pause, replay, and rotate webhook deliveries.
kf webhook pause-subscription
Pause an active webhook subscription.
Pause an active webhook subscription. No deliveries are attempted while paused.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--webhook-subscription-id <value> | yes | Webhook subscription id. |
Example
kf webhook pause-subscription --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-subscription-id <value>kf webhook replay-delivery
Redrive a scheduled or dead-lettered webhook delivery by moving it back to PENDING for the delivery worker.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--webhook-delivery-id <value> | yes | Webhook delivery id. |
--reset-attempts <value> | no | Reset attempts. |
Example
kf webhook replay-delivery --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-delivery-id <value>kf webhook resume-subscription
Resume a paused webhook subscription.
Resume a paused webhook subscription. Deliveries resume from the next event.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--webhook-subscription-id <value> | yes | Webhook subscription id. |
Example
kf webhook resume-subscription --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-subscription-id <value>kf webhook rotate-subscription-secret
Issue a fresh HMAC signing secret for a webhook subscription.
Issue a fresh HMAC signing secret for a webhook subscription. The new secret is returned exactly once in the command response; idempotent replays return null. Approval-gated: the approval is bound to commandType=RotateWebhookSubscriptionSecret and resourceId=webhookSubscriptionId within the tenant environment. TTL is per-request via dueOn/expiresOn, not fixed by the command.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--webhook-subscription-id <value> | yes | Webhook subscription id. |
Example
kf webhook rotate-subscription-secret --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-subscription-id <value>kf webhook upsert-subscription
Create or update a webhook subscription for a tenant.
Create or update a webhook subscription for a tenant. Defines event pattern, target URL, delivery mode, and signing secret reference.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--webhook-subscription-id <value> | no | Webhook subscription id. |
--event-pattern <value> | yes | Event pattern. |
--target-url <value> | yes | Target url. |
--signing-secret-ref-stdin | yes | Read Signing secret ref. from stdin. |
--delivery-mode <value> | yes | Delivery mode. |
--status <value> | yes | Status. |
Example
kf webhook upsert-subscription --tenant tnt_demo --actor-type USER --actor-id usr_sam --event-pattern <value> --target-url <value> --signing-secret-ref-stdin --delivery-mode <value> --status <value>