Skip to content

Commit a7fa8c1

Browse files
committed
docs: add webhook notification provider and update related documentation
- Introduced a new webhook notification provider in the meta.json file. - Updated the overview documentation to include webhook notifications as a supported method. - Created a detailed guide for configuring and testing webhook notifications, including JSON payload examples and production setup recommendations.
1 parent 56145b0 commit a7fa8c1

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

apps/docs/content/docs/core/(Notifications)/meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"lark",
99
"email",
1010
"gotify",
11-
"ntfy"
11+
"ntfy",
12+
"webhook"
1213
]
1314
}

apps/docs/content/docs/core/(Notifications)/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ Dokploy supports the following notification providers:
2929
5. **Email**: Email is a popular method for sending messages to a group of recipients.
3030
6. **Gotify**: Gotify is a self-hosted push notification service.
3131
7. **Ntfy**: Ntfy is a simple HTTP-based pub-sub notification service.
32+
8. **Webhook**: Webhook is a generic webhook notification service.
3233

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Webhook
3+
description: 'Configure webhook notifications for your applications.'
4+
---
5+
6+
Webhook notifications are a generic way to receive notifications from Dokploy to any HTTP endpoint. You can choose to receive notifications for specific events or all events. Notifications are sent in JSON format.
7+
8+
## Webhook Notifications
9+
10+
To start receiving webhook notifications, you need to fill the form with the following details:
11+
12+
- **Name**: Enter any name you want.
13+
- **Webhook URL**: Enter the webhook URL where you want to receive notifications. eg. `https://your-endpoint.com/webhook`
14+
15+
## Testing Your Webhook
16+
17+
For testing purposes, you can use [Webhook.site](https://webhook.site) to generate a unique URL and inspect the JSON payload that Dokploy sends:
18+
19+
1. Go to [https://webhook.site](https://webhook.site)
20+
2. Copy your unique webhook URL
21+
3. Go to Dokploy **Notifications** and select **Webhook** as the notification provider
22+
4. Enter a name for your notification configuration
23+
5. Paste the webhook URL you copied
24+
6. Click on **Test** to send a test notification
25+
7. Check your Webhook.site page to see the JSON payload
26+
8. Click on **Create** to save the notification
27+
28+
## JSON Format
29+
30+
Dokploy sends notifications in JSON format. The payload structure includes information about the event type, timestamp, and relevant details about the action that triggered the notification.
31+
32+
**Example notification payload:**
33+
34+
```json
35+
{
36+
"title": "Test Notification",
37+
"message": "Hi, From Dokploy 👋",
38+
"timestamp": "2025-12-07T19:41:53.470Z"
39+
}
40+
```
41+
42+
## Production Setup
43+
44+
For production use, ensure your webhook endpoint:
45+
46+
- Accepts POST requests
47+
- Returns a 2xx HTTP status code for successful delivery
48+
- Handles JSON payloads
49+
- Is accessible from the internet (or from your Dokploy server's network)
50+
- Implements proper authentication if needed (consider using HTTPS with API keys in headers)

0 commit comments

Comments
 (0)