Update Hook

Scopes
write:hook

Path Parameters

hook_id
string
Required

Hook id

Request Body

content
string

Your hook code written in javascript.

description
string

Additional information for the hook

enabled
boolean

Whether the hook is enabled or not.

name
string

Hook name

order
integer
min0
max
20000

Execution order of the hook. It applies to hook types. Lower ordered hooks executed first.

PATCH
/hooks/{hook_id}
1
2
3
4
5
Loading...
Response:
200
Loading...

Response Body Schema

content
string
Required

Your hook code written in javascript.

enabled
boolean
Required

Whether the hook is enabled or not.

id
string
Required

Unique identifier of entity

name
string
Required

Hook name

order
integer
Required
min0
max
20000

Execution order of the hook. It applies to hook types. Lower ordered hooks executed first.

type
string
Required

Defines hook's area of usage

Available Values: pre-registerpost-registerpre-loginpost-loginpre-mfapre-access-tokenpre-id-tokenpre-fc-importpost-fc-importpre-fc-exportciba-auth-promptciba-validate-r-cciba-validate-u-c

description
string

Additional information for the hook