Skip to content
Authrim

List webhook configurations.

GET
/api/admin/webhooks
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/webhooks?scope=tenant' \
  --header 'Authorization: Bearer <token>'

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Query Parameters

Section titled “Query Parameters ”
scope
string
Allowed values: tenant client
clientId
string
activeOnly
boolean
limit
integer
>= 1 <= 500
offset
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Webhook list response.

Media type application/json
object
webhooks
required
Array<object>
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
total
required
integer
Example generated
{
  "webhooks": [
    {
      "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"
    }
  ],
  "total": 1
}