ConfigHook

Sample shape for ConfigHook.

Sample shape for ConfigHook.

Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response.

{
  "itemAdd": "example",
  "itemUpdate": "example",
  "itemDelete": "example",
  "userAdd": "example",
  "userDelete": "example",
  "containerAdd": "example",
  "containerDelete": "example",
  "boardAdd": "example",
  "boardDelete": "example"
}

Fields

Field	Type	Required	Notes
entity	string • nullable	Server-set	Set by the server. Read-only on writes.
itemAdd	string	Optional
itemUpdate	string	Optional
itemDelete	string	Optional
userAdd	string	Optional
userDelete	string	Optional
containerAdd	string	Optional
containerDelete	string	Optional
boardAdd	string	Optional
boardDelete	string	Optional
tenantId	string	Server-set	Set by the server. Read-only on writes.
id	string	Server-set	Set by the server. Read-only on writes.
created	string (date-time)	Server-set	Set by the server. Read-only on writes.
createdBy	string	Server-set	Set by the server. Read-only on writes.
updated	string (date-time)	Server-set	Set by the server. Read-only on writes.
updatedBy	string	Server-set	Set by the server. Read-only on writes.
deleted	boolean	Server-set	Set by the server. Read-only on writes.

Used by

Request body

• PUT /api/admin/hook

CLI

ekso hook — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.