feat(webhooks): add blurb about dispatch webhooks, add to nav

This commit is contained in:
spiral 2021-11-25 17:13:15 -05:00
parent ece17f7470
commit ec8ecb1e96
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
2 changed files with 5 additions and 3 deletions

View File

@ -66,7 +66,7 @@ module.exports = {
"/api/endpoints",
"/api/models",
"/api/errors",
// "/api/integrations",
"/api/dispatch",
"/api/legacy"
]
},

View File

@ -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