NOnocodb
Hooks

Create hook

Changed on

Create a new hook for a table.

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

post/api/v3/meta/bases/{baseId}/tables/{tableId}/hooks

Request

Path parameters

baseIdstring required

Unique identifier for the base.

tableIdstring required

Unique identifier for the table.

Request body

titlestring required

Title of the hook.

descriptionstring

Description of the hook.

event'record' | 'manual'

Event trigger type. Defaults to '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.

Response

Hook created 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