Skip to content
UltimateTeam.ai Docs

Create a webhook subscription

POST
/api/v1/integrations/webhooks
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/integrations/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "event_filters": [ "example" ], "metadata": {}, "platform": "example", "webhook_url": "example" }'

Creates a new webhook subscription for the tenant. Auto-generates an HMAC signing secret. The secret is only returned in full on creation – subsequent reads will mask it.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateWebhookSubscriptionRequest

Request body for creating a webhook subscription.

Attributes: platform: Integration platform (zapier, make, custom). webhook_url: The HTTPS URL to deliver events to. event_filters: List of event type strings to subscribe to. metadata: Optional metadata dict.

object
event_filters
Event Filters

Event types to filter (empty = all events)

Array<string>
metadata
Metadata

Optional metadata

object
key
additional properties
any
platform
required
Platform

Platform: zapier, make, or custom

string
webhook_url
required
Webhook Url

HTTPS webhook URL

string
<= 2048 characters
Examplegenerated
{
  "event_filters": [
    "example"
  ],
  "metadata": {},
  "platform": "example",
  "webhook_url": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

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