Skip to content
UltimateTeam.ai Docs

Create a webhook subscription

POST
/api/v1/integrations/webhooks

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

Request Body required

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 types to filter (empty = all events)

Array<string>
metadata

Optional metadata

object
key
additional properties
any
platform
required

Platform: zapier, make, or custom

string
webhook_url
required

HTTPS webhook URL

string
<= 2048 characters

Responses

201

Successful Response

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
string
event_filters
required
Array<string>
failure_count
required
integer
id
required
string
is_active
required
boolean
platform
required
string
signing_secret
required
string
webhook_url
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string