Administration (opt-in)

Webhooks

List Webhooks

read-onlyidempotentopen-world
discourse_list_webhooks

List safe webhook summaries and the live authoring catalog without exposing webhook secrets or destination credentials.

Parameters

offsetinteger>= 0
limitinteger[1, 50]
activeboolean
delivery_statusstringinactivefailedsuccessfuldisabled
include_catalogboolean

Get Webhook

read-onlyidempotentopen-world
discourse_get_webhook

Get one fresh safe webhook configuration for inspection and mutation preconditions.

Parameters

webhook_idintegerrequired
include_catalogboolean

Create Webhook

open-world
discourse_create_webhook

Create a guarded outbound webhook using the live event and content-type catalog. External delivery and risky options require explicit confirmation.

Parameters

payload_urlstring<uri>required
content_typestringapplication/jsonapplication/x-www-form-urlencodedrequired
secretstring
activeboolean
verify_certificateboolean
wildcard_web_hookboolean
event_type_idsArray<integer>
category_idsArray<integer>
tag_idsArray<integer>
group_idsArray<integer>
confirm_activateboolean
confirm_wildcardboolean
confirm_insecure_httpboolean
confirm_disable_tls_verificationboolean
confirm_external_deliverybooleanrequired

Update Webhook

destructiveopen-world
discourse_update_webhook

Partially 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-urlencoded
secretstring
activeboolean
verify_certificateboolean
wildcard_web_hookboolean
event_type_idsArray<integer>
category_idsArray<integer>
tag_idsArray<integer>
group_idsArray<integer>
confirm_activateboolean
confirm_wildcardboolean
confirm_insecure_httpboolean
confirm_disable_tls_verificationboolean
webhook_idintegerrequired
expected_destination_fingerprintstringrequired
expected_activebooleanrequired
confirm_updatebooleanrequired
confirm_scope_replacementboolean
confirm_clear_secretboolean

Delete Webhook

destructiveopen-world
discourse_delete_webhook

Delete one webhook after a fresh exact destination-fingerprint precondition.

Parameters

webhook_idintegerrequired
expected_destination_fingerprintstringrequired
confirm_deletebooleanrequired

List Webhook Events

read-onlyidempotentopen-world
discourse_list_webhook_events

List bounded webhook delivery diagnostics. Payload and response previews are omitted unless explicitly confirmed.

Parameters

webhook_idintegerrequired
statusstringallsuccessfulfailed
offsetinteger>= 0
include_contentboolean
confirm_sensitive_contentboolean
content_limitinteger[100, 20000]

Ping Webhook

open-world
discourse_ping_webhook

Enqueue one explicitly confirmed external webhook ping after a fresh destination precondition.

Parameters

webhook_idintegerrequired
expected_destination_fingerprintstringrequired
confirm_external_requestbooleanrequired

Redeliver Webhook Event

destructiveopen-world
discourse_redeliver_webhook_event

Redeliver exactly one old webhook event after destination, ownership, and status preconditions. Bulk redelivery is not exposed.

Parameters

webhook_idintegerrequired
event_idintegerrequired
expected_destination_fingerprintstringrequired
expected_event_statusinteger[-1, 999]required
confirm_redeliverybooleanrequired