mirror of
https://github.com/Dokploy/website.git
synced 2026-06-15 20:25:25 +02:00
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.
This commit is contained in:
@@ -8,6 +8,7 @@
|
||||
"lark",
|
||||
"email",
|
||||
"gotify",
|
||||
"ntfy"
|
||||
"ntfy",
|
||||
"webhook"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -29,4 +29,5 @@ Dokploy supports the following notification providers:
|
||||
5. **Email**: Email is a popular method for sending messages to a group of recipients.
|
||||
6. **Gotify**: Gotify is a self-hosted push notification service.
|
||||
7. **Ntfy**: Ntfy is a simple HTTP-based pub-sub notification service.
|
||||
8. **Webhook**: Webhook is a generic webhook notification service.
|
||||
|
||||
|
||||
50
apps/docs/content/docs/core/(Notifications)/webhook.mdx
Normal file
50
apps/docs/content/docs/core/(Notifications)/webhook.mdx
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Webhook
|
||||
description: 'Configure webhook notifications for your applications.'
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
## Webhook Notifications
|
||||
|
||||
To start receiving webhook notifications, you need to fill the form with the following details:
|
||||
|
||||
- **Name**: Enter any name you want.
|
||||
- **Webhook URL**: Enter the webhook URL where you want to receive notifications. eg. `https://your-endpoint.com/webhook`
|
||||
|
||||
## Testing Your Webhook
|
||||
|
||||
For testing purposes, you can use [Webhook.site](https://webhook.site) to generate a unique URL and inspect the JSON payload that Dokploy sends:
|
||||
|
||||
1. Go to [https://webhook.site](https://webhook.site)
|
||||
2. Copy your unique webhook URL
|
||||
3. Go to Dokploy **Notifications** and select **Webhook** as the notification provider
|
||||
4. Enter a name for your notification configuration
|
||||
5. Paste the webhook URL you copied
|
||||
6. Click on **Test** to send a test notification
|
||||
7. Check your Webhook.site page to see the JSON payload
|
||||
8. Click on **Create** to save the notification
|
||||
|
||||
## JSON Format
|
||||
|
||||
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.
|
||||
|
||||
**Example notification payload:**
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Test Notification",
|
||||
"message": "Hi, From Dokploy 👋",
|
||||
"timestamp": "2025-12-07T19:41:53.470Z"
|
||||
}
|
||||
```
|
||||
|
||||
## Production Setup
|
||||
|
||||
For production use, ensure your webhook endpoint:
|
||||
|
||||
- Accepts POST requests
|
||||
- Returns a 2xx HTTP status code for successful delivery
|
||||
- Handles JSON payloads
|
||||
- Is accessible from the internet (or from your Dokploy server's network)
|
||||
- Implements proper authentication if needed (consider using HTTPS with API keys in headers)
|
||||
Reference in New Issue
Block a user