Skip to content
No results found.

Create Hook

Scopes
write:hook

Request Body

content
string
Required

Your hook code written in javascript.

name
string
Required
length
3-64

Hook name

type
string
Required

Defines hook's area of usage

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

Default Value: "sms"

description
string
length
0-256

Additional information for the hook

enabled
boolean

Whether the hook is enabled or not.

order
number
min0
max
20000

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

POST
/hooks
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
4
5
Loading...
Response
200
200
Loading...

Response Body Schema

content
string
Required

Your hook code written in javascript.

created_at
string
Required

Creation date in the ISO 8601 format according to universal time.

description
string
Required
length
0-256

Additional information for the hook

enabled
boolean
Required

Whether the hook is enabled or not.

id
string
Required
length
0-16

Unique identifier of entity

name
string
Required
length
3-64

Hook name

order
number
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: smslink-accountpre-registerpost-registerpre-loginpost-loginpre-mfapre-access-tokenpre-id-tokenpre-fc-importpost-fc-importpre-fc-exportciba-auth-promptciba-validate-r-cciba-validate-u-c

Default Value: "sms"

updated_at
string

Update date in the ISO 8601 format according to universal time.