Skip to content
Developers
No results found.

List Hooks

Scopes
read:hook

Query Parameters

fields
string | array<string>

Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id,created_at" 

limit
integer
min-1
max
500

Limit the number of results returned

Examples: 5 

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 | array<string>

Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id.asc,created_at.desc" "email.asc" 

GET
/hooks
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
Paginated list of hooks
Loading...

Response Body Schema

total
integer
Required
results
array<object>
results.
content
string
Required

Your hook code written in javascript.

results.
created_at
string
Required

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

results.
description
string
Required
length
0-256

Additional information for the hook

results.
enabled
boolean
Required

Whether the hook is enabled or not.

results.
id
string
Required
length
0-16

Unique identifier of entity

results.
name
string
Required
length
3-∞

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: 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

results.
updated_at
string

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