Update logout webhook configuration

PUT

/api/admin/settings/logout-webhook

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/logout-webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "url": "https://hooks.example.com/logout", "timeout_seconds": 5, "signing_secret_ref": "logout_webhook_secret", "retry": { "enabled": true, "max_attempts": 3, "backoff_seconds": 10 } }'

Deep-merges partial logout webhook configuration into SETTINGS KV after validation.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

key

additional properties

Example

{
  "enabled": true,
  "url": "https://hooks.example.com/logout",
  "timeout_seconds": 5,
  "signing_secret_ref": "logout_webhook_secret",
  "retry": {
    "enabled": true,
    "max_attempts": 3,
    "backoff_seconds": 10
  }
}

Responses

200

Logout webhook settings mutation result.

Media type application/json

object

success

boolean

config

object

key

additional properties

source

string

defaults

object

key

additional properties

note

string

key

additional properties

Example

{
  "success": true,
  "config": {
    "enabled": true,
    "url": "https://hooks.example.com/logout",
    "timeout_seconds": 5,
    "signing_secret_ref": "logout_webhook_secret",
    "retry": {
      "enabled": true,
      "max_attempts": 3,
      "backoff_seconds": 10
    }
  },
  "note": "Logout webhook configuration updated. Changes take effect immediately."
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}