Hooks
Create Hook
Install an autonomous hook that triggers skill execution when matching events occur.
POST
Create Hook
Request
ID of a built-in hook preset (e.g.,
share.accepted.welcome, task.overdue.summary). Mutually exclusive with event_pattern.Custom event pattern to match. Supports exact match (
share.accepted), glob wildcards (order.*.completed), prefix match (share), or catch-all (*). Mutually exclusive with hook_preset_id.Slug of the skill to execute when the hook fires.
Minimum time between firings in minutes (1–1440). A server-side default is applied when omitted.
Response
The hook’s unique UUID.
The resolved event pattern (from preset or custom).
The target skill slug.
Always
true on creation.Cooldown period between firings.
Authentication
Requires an API key withcompletions scope.
Example
Guard Rails
- Pre-flight credit check before each autonomous execution
- Separate daily cap for autonomous actions
- Per-run caps on tool invocations and total spend
- Hooks auto-pause after repeated failures
- Cooldown enforced between firings
Create Hook
