v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Webhooks

Create Webhook

Create a new webhook for the current user.

  • data: CreateWebhookPayload - The data for creating the webhook.
  • user: User - The current authenticated user.

Returns: dict - The created webhook data.

post/v2/webhooks

Headers

user-agentstring nullable
authorizationstring nullable

Request body

urlstring uri required
sharedSecretstring nullable
allPassTemplatesboolean nullable
allowedTemplatesPydanticObjectId[] nullable
allEventTypesboolean nullable

Example request

{
  "allowedTemplates": [
    "5eb7cf5a86d9755df3a6c593"
  ]
}

Response

Successful Response

{"stackTrail":"paths:/v2/webhooks:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}