Skip to content
UltimateTeam.ai Docs

List webhook subscriptions

GET
/api/v1/integrations/webhooks
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/integrations/webhooks \
  --header 'X-API-Key: <X-API-Key>'

Lists all active webhook subscriptions for the tenant. Signing secrets are masked (only last 4 characters shown).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
platform
Any of:
string

Filter by platform

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Webhook Subscriptions Api V1 Integrations Webhooks Get
Array<object>
WebhookSubscriptionResponse

Response body for a webhook subscription.

Attributes: id: Subscription UUID. platform: Integration platform. webhook_url: The webhook URL. signing_secret: HMAC signing secret (full on create, masked on read). event_filters: Active event filters. is_active: Whether the subscription is active. failure_count: Consecutive delivery failures. created_at: When the subscription was created.

object
created_at
required
Created At
string
event_filters
required
Event Filters
Array<string>
failure_count
required
Failure Count
integer
id
required
Id
string
is_active
required
Is Active
boolean
platform
required
Platform
string
signing_secret
required
Signing Secret
string
webhook_url
required
Webhook Url
string
Examplegenerated
[
  {
    "created_at": "example",
    "event_filters": [
      "example"
    ],
    "failure_count": 1,
    "id": "example",
    "is_active": true,
    "platform": "example",
    "signing_secret": "example",
    "webhook_url": "example"
  }
]

422

Section titled “422”

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