Webhooks
List Webhooks
read-onlyidempotentopen-worldList safe webhook summaries and the live authoring catalog without exposing webhook secrets or destination credentials.
Parameters
offsetinteger>= 0limitinteger[1, 50]activebooleandelivery_ statusstringinactivefailedsuccessfuldisabledinclude_ catalogbooleanGet Webhook
read-onlyidempotentopen-worldGet one fresh safe webhook configuration for inspection and mutation preconditions.
Parameters
webhook_ idintegerrequiredinclude_ catalogbooleanCreate Webhook
open-worldCreate a guarded outbound webhook using the live event and content-type catalog. External delivery and risky options require explicit confirmation.
Parameters
payload_ urlstring<uri>requiredcontent_ typestringapplication/jsonapplication/x-www-form-urlencodedrequiredsecretstringactivebooleanverify_ certificatebooleanwildcard_ web_ hookbooleanevent_ type_ idsArray<integer>category_ idsArray<integer>tag_ idsArray<integer>group_ idsArray<integer>confirm_ activatebooleanconfirm_ wildcardbooleanconfirm_ insecure_ httpbooleanconfirm_ disable_ tls_ verificationbooleanconfirm_ external_ deliverybooleanrequiredUpdate Webhook
destructiveopen-worldPartially update a webhook after fresh destination and active-state preconditions. Relationship arrays are complete replacements.
Parameters
payload_ urlstring<uri>content_ typestringapplication/jsonapplication/x-www-form-urlencodedsecretstringactivebooleanverify_ certificatebooleanwildcard_ web_ hookbooleanevent_ type_ idsArray<integer>category_ idsArray<integer>tag_ idsArray<integer>group_ idsArray<integer>confirm_ activatebooleanconfirm_ wildcardbooleanconfirm_ insecure_ httpbooleanconfirm_ disable_ tls_ verificationbooleanwebhook_ idintegerrequiredexpected_ destination_ fingerprintstringrequiredexpected_ activebooleanrequiredconfirm_ updatebooleanrequiredconfirm_ scope_ replacementbooleanconfirm_ clear_ secretbooleanDelete Webhook
destructiveopen-worldDelete one webhook after a fresh exact destination-fingerprint precondition.
Parameters
webhook_ idintegerrequiredexpected_ destination_ fingerprintstringrequiredconfirm_ deletebooleanrequiredList Webhook Events
read-onlyidempotentopen-worldList bounded webhook delivery diagnostics. Payload and response previews are omitted unless explicitly confirmed.
Parameters
webhook_ idintegerrequiredstatusstringallsuccessfulfailedoffsetinteger>= 0include_ contentbooleanconfirm_ sensitive_ contentbooleancontent_ limitinteger[100, 20000]Ping Webhook
open-worldEnqueue one explicitly confirmed external webhook ping after a fresh destination precondition.
Parameters
webhook_ idintegerrequiredexpected_ destination_ fingerprintstringrequiredconfirm_ external_ requestbooleanrequiredRedeliver Webhook Event
destructiveopen-worldRedeliver exactly one old webhook event after destination, ownership, and status preconditions. Bulk redelivery is not exposed.
Parameters
webhook_ idintegerrequiredevent_ idintegerrequiredexpected_ destination_ fingerprintstringrequiredexpected_ event_ statusinteger[-1, 999]requiredconfirm_ redeliverybooleanrequired