Get webhook subscription details

GET

/api/v1/integrations/webhooks/{subscription_id}

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

• Production
• Local development

Returns details for a single webhook subscription. Signing secret is masked.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

subscription_id

required

Subscription Id

string

Responses

200

Successful Response

Media typeapplication/json

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

Example^generated

{
  "created_at": "example",
  "event_filters": [
    "example"
  ],
  "failure_count": 1,
  "id": "example",
  "is_active": true,
  "platform": "example",
  "signing_secret": "example",
  "webhook_url": "example"
}

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

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}