Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ jobs:
# to be swept, and that list only ever shrinks.
- run: yarn test:comment-length

# The Webhooks page reads server main's openapi/webhooks.json, and its preview
# mirrors the payload rules. This fails when either drifts from the server.
- run: yarn test:webhook-spec

# `next build` type-checks as part of building and there is no separate
# typecheck script, so this is both.
- run: yarn build
Expand Down
7 changes: 6 additions & 1 deletion content/docs/build/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Bots, addons, plugins, and the packages you can build against
icon: Blocks
---

Four ways to extend Gryt, and they run in different places. Which one you want
Five ways to extend Gryt, and they run in different places. Which one you want
depends on where your code needs to live.

## Pick where your code runs
Expand All @@ -25,6 +25,11 @@ depends on where your code needs to live.
description="Runs in the server, sees messages and members"
href="/docs/build/server-plugins"
/>
<Card
title="A webhook"
description="One HTTP request, and a message shows up in a channel"
href="/docs/build/webhooks"
/>
<Card
title="Both halves"
description="A server plugin and a client addon that talk to each other"
Expand Down
3 changes: 2 additions & 1 deletion content/docs/build/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@
"server-plugins",
"server-plugin-api",
"plugin-pairs",
"---Bots---",
"---Bots and webhooks---",
"bots",
"bot-api",
"webhooks",
"---The server's own API---",
"server-api",
"---Voice SDK---",
Expand Down
2 changes: 2 additions & 0 deletions content/docs/build/server-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ browser isn't the thing talking to BetterTTV or emoji.gg.

### Webhooks

The payload, its limits and its errors are on [Webhooks](/docs/build/webhooks).

| Method | Path | Auth | Notes |
|--------|------|------|-------|
| POST | `/api/webhooks/:webhookId/:token` | Token in the path | Post as the webhook |
Expand Down
Loading
Loading