Get a webhook subscription
GET
/webhooks/{webhook_id}
const url = 'http://localhost:8000/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url http://localhost:8000/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'API-Key: <API-Key>'Required scope: webhooks:read
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”webhook_id
required
string format: uuid
Responses
Section titled “Responses”The request has succeeded.
Media typeapplication/json
Saved webhook subscription for the authenticated workspace.
object
id
required
string format: uuid
name
required
string
url
required
string
enabled
required
boolean
source
required
string
event_types
required
Array<string>
cluster_id
string format: uuid
realm_id
string
has_authorization_header
required
boolean
has_signing_secret
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
"source": "keycloak"
}The server could not understand the request due to invalid syntax.
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is unauthorized.
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is forbidden.
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
errors
required
Array<object>
object
field
required
string
detail
required
string
code
string
value
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"errors": [
{
"field": "example",
"detail": "example",
"code": "example",
"value": "example"
}
]
}Client error
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer
Server error
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}