Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

feat(docs): add outgoing webhooks

Tind338bddddab7
diff --git a/apps/docs/core/functional/index.mdx b/apps/docs/core/functional/index.mdx
index feb53f680..d72677e0e 100644
--- a/apps/docs/core/functional/index.mdx
+++ b/apps/docs/core/functional/index.mdx
@@ -18,4 +18,5 @@ Use these guides when you want to get work done in Kaneo, not just configure inf
- [Quick Start](/core/index)
- [GitHub Integration Setup](/core/integrations/github/setup)
+- [Outgoing webhooks](/core/integrations/outgoing-webhooks)
- [API Introduction](/api-reference/introduction)
diff --git a/apps/docs/core/functional/personalize-your-workspace.mdx b/apps/docs/core/functional/personalize-your-workspace.mdx
index 3debc7b42..c4340a0da 100644
--- a/apps/docs/core/functional/personalize-your-workspace.mdx
+++ b/apps/docs/core/functional/personalize-your-workspace.mdx
@@ -36,7 +36,7 @@ If needed, use **Reset** in preferences to return to defaults.
Also review:
- **Settings -> Workspace** for workspace-level details
-- **Settings -> Projects** for project general, visibility, integrations, and workflow
+- **Settings -> Projects** for project general, visibility, integrations, and workflow (see [Outgoing webhooks](/core/integrations/outgoing-webhooks))
## Suggested baseline for most teams
diff --git a/apps/docs/core/integrations/outgoing-webhooks.mdx b/apps/docs/core/integrations/outgoing-webhooks.mdx
new file mode 100644
index 000000000..7393ac179
--- /dev/null
+++ b/apps/docs/core/integrations/outgoing-webhooks.mdx
@@ -0,0 +1,77 @@
+---
+title: Outgoing webhooks
+description: Send task activity from a Kaneo project to Slack, Discord, or any HTTP endpoint. Configure per-project notifications and optional signing.
+---
+
+Kaneo can notify external systems when tasks change in a project. Each integration is per project and uses an incoming webhook URL from the service you connect (Slack, Discord) or your own HTTP listener (generic webhook).
+
+<Info>
+These integrations are outgoing only: Kaneo posts to your URL when events occur. They are separate from [GitHub integration](/core/integrations/github/setup), which syncs issues and repositories.
+</Info>
+
+## Where to configure
+
+1. Open **Settings** in the sidebar.
+2. Under **Projects**, select the project.
+3. Open the **Integrations** tab.
+
+You will see sections for **GitHub**, **Discord**, **Generic webhook**, and **Slack**. Configure Slack, Discord, or generic webhooks in their respective sections.
+
+## Task links in notifications
+
+Notification messages and generic webhook payloads include links to the task in the web app. Set [`KANEO_CLIENT_URL`](/core/installation/environment-variables) to your public Kaneo web URL so those links point to your instance (for example `https://kaneo.example.com`).
+
+## Events you can subscribe to
+
+For Slack, Discord, and generic webhooks you can toggle the same event types:
+
+| Event | Default on | Description |
+| --- | --- | --- |
+| Task created | Yes | New task in the project |
+| Task status changed | Yes | Status column changed |
+| Task priority changed | No | Priority changed |
+| Task title changed | No | Title edited |
+| Task description changed | No | Description edited |
+| Task comment created | Yes | New comment on a task |
+
+Defaults apply when you first connect; you can change toggles anytime in project settings.
+
+## Slack
+
+Use a [Slack incoming webhook](https://api.slack.com/messaging/webhooks) URL. It must match Slack’s format:
+
+`https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`
+
+Paste the URL in the Slack section, optionally set a channel label for your own reference, choose events, and save.
+
+Kaneo sends formatted messages to Slack when enabled events occur.
+
+## Discord
+
+Create an incoming webhook for a Discord channel (Channel settings → Integrations → Webhooks). The URL must look like:
+
+`https://discord.com/api/webhooks/000000000000000000/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
+
+(or the `discordapp.com` hostname). Paste it into the Discord section, optionally add a channel name label, select events, and save.
+
+## Generic HTTP webhook
+
+Use a generic webhook when you want a JSON POST to your own service, automation, or middleware.
+
+### Delivery health
+
+After delivery attempts, Kaneo stores basic health metadata (for example last success, last failure message, failure count) so you can see whether recent posts succeeded. This does not replace monitoring on your endpoint.
+
+### Payload shape
+
+Each POST has `Content-Type: application/json`. Top-level fields:
+
+- `event`: string, one of: `task.created`, `task.status_changed`, `task.priority_changed`, `task.title_changed`, `task.description_changed`, `task.comment_created`
+- `timestamp`: ISO 8601 time when Kaneo sent the request
+- `integration`: `{ "type": "generic-webhook" }`
+- `project`: `id`, `name`, `workspaceId`
+- `task`: `id`, `number`, `title`, `status`, `priority`, `url` (link to the task in the web UI)
+- `actor`: `id` and `name` of the user when available, or nulls for automated actions
+- `data`: event-specific fields (for example `oldStatus` / `newStatus` for status changes, `comment` text for comments)
+
+Use these payloads to drive custom workflows, internal dashboards, or bridges to other tools.
diff --git a/apps/docs/docs.json b/apps/docs/docs.json
index e33144703..a201da976 100644
--- a/apps/docs/docs.json
+++ b/apps/docs/docs.json
@@ -79,6 +79,10 @@
"core/integrations/github/troubleshooting"
]
},
+ {
+ "group": "Outgoing webhooks",
+ "pages": ["core/integrations/outgoing-webhooks"]
+ },
{
"group": "Authentication Providers",
"pages": [
diff --git a/apps/docs/index.mdx b/apps/docs/index.mdx
index 41c4bb690..9c82d3899 100644
--- a/apps/docs/index.mdx
+++ b/apps/docs/index.mdx
@@ -11,6 +11,7 @@ This docs site is built to get you from zero to a running instance fast, then he
- [Quick Start](/core/index) for the fastest path to a running instance
- [Installation Guide](/core/installation/index) to choose drim vs Docker Compose
- [GitHub Integration Setup](/core/integrations/github/setup) for repo sync
+- [Outgoing webhooks](/core/integrations/outgoing-webhooks) for Slack, Discord, and custom HTTP notifications
- [API Introduction](/api-reference/introduction) for authenticated API usage
## Why Kaneo Exists