COconductorone
Hook

Create

Changed on

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

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/hooks
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

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

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new HOOK_EVENT_TYPE_PRE_OUTPUT enum value to the request property

    • info

      added subschema #2 to the request property oneOf list

    • info

      added subschema #2 to the request property oneOf list

    • info

      added subschema #2 to the request property oneOf list

  • fa2bb307d6faRevision changes
    • info

      endpoint added