Türkçe dil desteğimiz henüz tamamlandı. Eksik sayfalar veya bölümlerle karşılaşmanız durumunda İngilizce dilini seçerek sayfanın orjinalini görebilirsiniz.

List All Hooks

Scopes
read:hook
offset
integer
min0
max
99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

limit
integer
min-1
max
500

Limit the number of results returned

sort_by
string

Properties that should be ordered by with their order type. To define order append it to the field with dot. For example: sort_by=email.asc or sort_by=email.desc

q
string

Additional query in PlusAuth Query Language format.

GET
/hooks
1
2
3
Loading...
Response:
200
Loading...

Response Body Schema

results
array<object>
results.
content
string
REQUIRED

Your hook code written in javascript.

results.
description
string

Additional information for the hook

results.
enabled
boolean
REQUIRED

Whether the hook is enabled or not.

results.
id
string
REQUIRED

Unique identifier of entity

results.
name
string
REQUIRED

Hook name

results.
order
integer
REQUIRED
min0
max
20000

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

results.
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

total
integer