Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Webhooks

Update Webhook Information

Update the information of a specific webhook.

  • data: CreateWebhookPayload - The updated data for the webhook.
  • webhook: Webhook - The webhook instance loaded by webhook ID.

Returns: dict - The updated webhook information.

put/v2/webhooks/{webhookId}

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Headers

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/{webhookId}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}