Skip to content

Commit 9aaa89e

Browse files
committed
Document volume alerting webhook
1 parent 4d07472 commit 9aaa89e

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

src/docs/guides/webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Complete the following steps to setup a webhook:
1616
4. Input your desired webhook URL.
1717
5. Click `Save Webhook`.
1818

19-
The URL you provide will receive a webhook payload when any service's deployment status changes. This will be executed across all environments in the project.
19+
The URL you provide will receive a webhook payload when any service's deployment status changes or an alert is triggered. This will be executed across all environments in the project.
2020

2121
To see what payload will be transmitted to the URL, you can expand the "Example webhook payload" panel.
2222

src/docs/reference/webhooks.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,18 @@ width={823} height={324} quality={80} />
1111

1212
## How it Works
1313

14+
### Deployment Status
15+
1416
When a deployment's status changes, Railway will send a notification via HTTP to the URL provided in the webhook configuration.
1517

1618
Deployment states can be found [here](/reference/deployments#deployment-states).
1719

20+
### Alerts
21+
22+
When a volume usage breaches certain thresholds, Railway will send a notification to pro customers via HTTP to the URL provided in the webhook configuration.
23+
24+
The thresholds that alert can be configured in the volume settings page.
25+
1826
## Muxers
1927

2028
Webhooks contain Muxers which will automatically identify webhook URLs and transform the payload based on where it's going. Below are the currently supported Muxers:
@@ -23,4 +31,4 @@ Webhooks contain Muxers which will automatically identify webhook URLs and trans
2331

2432
## Setting up a webhook
2533

26-
For information on how to setup webhooks, visit [this guide](/guides/webhooks).
34+
For information on how to setup webhooks, visit [this guide](/guides/webhooks).

0 commit comments

Comments
 (0)