Skip to content

List public webhook event types

GET
/v1/webhooks/events
import requests
resp = requests.get(
"https://api.ultimateteam.ai/v1/webhooks/events",
headers={"X-API-Key": "utk_live_YOUR_KEY"},
)
print(resp.json())

Return the catalog of event types that can be subscribed to via the public webhook API. Each entry includes a short description and an example payload that the docs site can render without calling the backend.

X-API-Key
Any of:
string

Successful Response

Media typeapplication/json
Response List Event Catalog V1 Webhooks Events Get
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}