List All Hooks

Scopes
read:hook

Query Parameters

limit
integer
min-1
max
500

Limit the number of results returned

offset
integer
min0
max
99999999999999

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

q
string

Additional query in PlusAuth Query Language format.

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

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

Response Body Schema

results
array<object>
results.
content
string
Zorunlu

Your hook code written in javascript.

results.
enabled
boolean
Zorunlu

Whether the hook is enabled or not.

results.
id
string
Zorunlu

Unique identifier of entity

results.
name
string
Zorunlu

Hook name

results.
order
integer
Zorunlu
min0
max
20000

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

results.
type
string
Zorunlu

Defines hook's area of usage

Mevcut Değerler: pre-registerpost-registerpre-loginpost-loginpre-mfapre-access-tokenpre-id-tokenpre-fc-importpost-fc-importpre-fc-exportciba-auth-promptciba-validate-r-cciba-validate-u-c

results.
description
string

Additional information for the hook

total
integer