NOnocodb
Hooks

Update hook

Changed on

Update the details of a specific hook.

Note: Hook APIs are available on cloud-hosted Business plans and above, and on licensed self-hosted deployments (Business plan and above).

patch/api/v3/meta/bases/{baseId}/hooks/{hookId}

Request

Path parameters

baseIdstring required

Unique identifier for the base.

hookIdstring required

Unique identifier for the hook.

Request body

titlestring

Title of the hook.

descriptionstring

Description of the hook.

event'record' | 'manual'

Event trigger type. 'record' triggers after the operation completes.

operationstring[]

Operations that trigger the hook.

activeboolean

Indicates if the hook is active.

trigger_fieldsstring[]

Field IDs that trigger the hook when modified.

Response

Hook updated successfully.

idstring required

Unique identifier for the hook.

table_idstring required

Unique identifier of the associated table.

titlestring required

Title of the hook.

descriptionstring nullable

Description of the hook.

event'record' | 'manual' required

Event trigger type. 'record' triggers after the operation completes.

operationstring[] required

Operations that trigger the hook.

activeboolean

Indicates if the hook is active.

trigger_fieldsstring[]

Field IDs that trigger the hook when modified.

created_atstring date-time

Timestamp when the hook was created.

updated_atstring date-time

Timestamp when the hook was last updated.

Changes