Hook

Create

Create creates a hook. The hook fires on the configured event, optionally filtered by a CEL expression. Creating a Patch tool input hook requires the preview feature to be enabled for the tenant.

post/api/v1/hooks

Request body

descriptionstring

The description field.

displayNamestring required

The displayName field.

enabledboolean

The enabled field.

event'HOOK_EVENT_TYPE_UNSPECIFIED' | 'HOOK_EVENT_TYPE_PRE_TOOL_USE' | 'HOOK_EVENT_TYPE_POST_TOOL_USE' | 'HOOK_EVENT_TYPE_PRE_OUTPUT'

The event field.

managedByGuardrailsboolean

The managedByGuardrails field.

priorityinteger

The priority field.

Response

Successful response

Changes