Sign in
latestOpenAPI 3.1.02026-08-2279358229.2 KB

b496a7929e98

webhooks

Create a webhook

Creates a webhook endpoint. Optional event_schemas may be supplied at creation time to customize data.object for supported event namespaces while preserving the normal webhook envelope.

post/v1/webhooks

Headers

Authorizationstring required

Bearer authentication

Request body

urlstring required

Webhook endpoint URL

secretstring

Secret for webhook signature verification

enabled_eventsstring[] required

Array of event types to subscribe to, or ["*"] for all events

oidc_auth_method'private_key_jwt' | 'client_secret'

OIDC authentication method for obtaining access tokens. Required when configuring OIDC. 'private_key_jwt' — requires oidc_client_id, oidc_token_endpoint, oidc_access_token_ttl_seconds. 'client_secret' — requires oidc_client_id, oidc_client_secret, oidc_token_endpoint, oidc_access_token_ttl_seconds. Both methods optionally accept oidc_scope and oidc_resource_uri.

oidc_client_idstring

OIDC client ID. Required for both auth methods.

oidc_client_secretstring

OIDC client secret. Required when oidc_auth_method is 'client_secret'. Write-only; never returned in responses.

oidc_token_endpointstring

OIDC token endpoint URL. Required for both auth methods.

oidc_resource_uristring

Optional. OIDC resource URI (Microsoft-specific; use oidc_scope for standard OAuth 2.0).

oidc_scopestring

Optional. OAuth 2.0 scope for the token request (e.g. "api://<app-id>/.default").

oidc_access_token_ttl_secondsinteger

OIDC access token TTL in seconds. Required for both auth methods.

Response

webhook created with wildcard events

{"stackTrail":"paths:/v1/webhooks:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","description":"Any type"}