Get Hook

Scopes
read:hook

Path Parameters

hook_id
string
REQUIRED

Hook id

GET
/hooks/{hook_id}
1
2
3
Loading...
Response:
200
Loading...

Response Body Schema

content
string
REQUIRED

Your hook code written in javascript.

description
string

Additional information for the hook

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