Skip to main content
PUT
/
api
/
v3
/
network-settings
/
prehook
Update prehook configuration
curl --request PUT \
  --url https://apix.us.amity.co/api/v3/network-settings/prehook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "callbackUrl": "<string>",
  "defaultAction": "allow",
  "regenerateKey": true
}'
{
  "enabled": true,
  "callbackUrl": "<string>",
  "defaultAction": "allow",
  "secretKey": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Information of a prehook to be updated.

​
enabled
boolean
​
callbackUrl
string
Maximum length: 900
​
defaultAction
enum<string>
Available options:
allow,
deny
​
regenerateKey
boolean

An option for regenerating the secret key.

Response

Prehook configuration

Prehook Setting

​
enabled
boolean
​
callbackUrl
string
​
defaultAction
enum<string>
Available options:
allow,
deny
​
secretKey
string

This will be available only when regenerateKey or enable the feature for the first time