Set Platform Webhook Key

PUT

/api/admin/webhook

curl --request PUT \
  --url https://example.com/api/admin/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example" }'

Set or rotate the shared webhook key. An empty value clears the override (reverts to config).

Authorizations

• Bearer

Request Body

object

key

string

nullable

Example ^generated

{
  "key": "example"
}

object

key

string

nullable

Example ^generated

{
  "key": "example"
}

object

key

string

nullable

Example ^generated

{
  "key": "example"
}

Responses

200

OK

Media type application/json

object

endpointPath

string

nullable

key

string

nullable

keyConfigured

boolean

source

string

nullable

Example ^generated

{
  "endpointPath": "example",
  "key": "example",
  "keyConfigured": true,
  "source": "example"
}