From ec8ecb1e969f14cb6623005dd5c58277679475cf Mon Sep 17 00:00:00 2001 From: spiral Date: Thu, 25 Nov 2021 17:13:15 -0500 Subject: [PATCH] feat(webhooks): add blurb about dispatch webhooks, add to nav --- docs/content/.vuepress/config.js | 2 +- docs/content/api/dispatch.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/content/.vuepress/config.js b/docs/content/.vuepress/config.js index 8764b640..44a60ccf 100644 --- a/docs/content/.vuepress/config.js +++ b/docs/content/.vuepress/config.js @@ -66,7 +66,7 @@ module.exports = { "/api/endpoints", "/api/models", "/api/errors", - // "/api/integrations", + "/api/dispatch", "/api/legacy" ] }, diff --git a/docs/content/api/dispatch.md b/docs/content/api/dispatch.md index 71a336b9..e3b0b72c 100644 --- a/docs/content/api/dispatch.md +++ b/docs/content/api/dispatch.md @@ -1,11 +1,13 @@ --- -title: Dispatch Webhooks +title: Dispatch permalink: /api/dispatch --- # Dispatch Webhooks -todo: write text here +Dispatch webhooks are a way to get notified when you update your system information on PluralKit. It can be used for integrations where you want to perform some action when you run a bot command on Discord, but also don't want to (or can't) set up a Discord bot to listem to messages. + +You will need a publicly-accessible webserver that can receive and process JSON-formatted POST requests. ## Security