Get a webhook configuration.

GET

/api/admin/webhooks/{id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/webhooks/example \
  --header 'Authorization: Bearer <token>'

Get Webhook in the Webhooks area. Use this operation to retrieve webhook data without mutating tenant state.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Responses

200

Webhook response.

Media type application/json

object

webhook

required

object

id

string

tenantId

string

clientId

string | null

scope

string

name

string

url

string format: uri

events

Array<string>

hasSecret

boolean

headers

object

key

additional properties

string

retryPolicy

object

maxRetries

integer

<= 10

initialDelayMs

integer

backoffMultiplier

number

>= 1

maxDelayMs

integer

key

additional properties

timeoutMs

integer

active

boolean

createdAt

string

updatedAt

string

lastSuccessAt

string | null

lastFailureAt

string | null

key

additional properties

Example ^generated

{
  "webhook": {
    "id": "example",
    "tenantId": "example",
    "clientId": "example",
    "scope": "example",
    "name": "example",
    "url": "https://example.com",
    "events": [
      "example"
    ],
    "hasSecret": true,
    "headers": {
      "additionalProperty": "example"
    },
    "retryPolicy": {
      "maxRetries": 1,
      "initialDelayMs": 1,
      "backoffMultiplier": 1,
      "maxDelayMs": 1
    },
    "timeoutMs": 1,
    "active": true,
    "createdAt": "example",
    "updatedAt": "example",
    "lastSuccessAt": "example",
    "lastFailureAt": "example"
  }
}

404

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"
}