Skip to content

Commit 4ed77a4

Browse files
committed
chore: update description
1 parent 124bf0a commit 4ed77a4

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed
Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Outbound Webhooks
3-
description: Notify 3rd party applications after each deployment with Stormkit.
3+
description: Easily automate actions with outbound webhooks, enabling triggers for events like cache disabling and workflow initiation. Boost deployment flexibility and streamline notifications with this powerful feature.
44
---
55

66
# Outbound Webhooks
@@ -17,7 +17,6 @@ To enable users to define outbound webhooks upon deployment completion, follow t
1717

1818
- Fill out the required information in the form and proceed by clicking the `Create outbound` webhook button.
1919

20-
2120
</section>
2221

2322
## Special variables for payload
@@ -26,15 +25,15 @@ To enable users to define outbound webhooks upon deployment completion, follow t
2625

2726
When the `Request method` is selected as `Post`, you can specify the request payload. This field accepts a raw string that will be send to the request URL. You can use the following variables to customize the request payload.
2827

29-
| Variable | Description |
30-
| ------------------------- | ---------- |
31-
| `$SK_NOW` | An ISO 8601 formatted time string. The time is computed when sending the webhook. |
32-
| `$SK_NOW_UNIX` | The unix timestamp. The time is computed when sending the webhook. |
33-
| `$SK_APP_ID` | The application id. |
34-
| `$SK_ENVIRONMENT` | The environment name. When triggering an outbound webhook on publish, this is the name of the environment that the deployment is published to. Otherwise, it is the name of the environment which the build configuration is taken from. |
35-
| `$SK_DEPLOYMENT_ID` | The deployment id. |
36-
| `$SK_DEPLOYMENT_ENDPOINT` | The endpoint to preview the deployment. |
37-
| `$SK_DEPLOYMENT_LOGS_ENDPOINT` | The endpoint to preview the deployment logs. You will need to be authenticated to visit this URL. |
38-
| `$SK_DEPLOYMENT_STATUS` | A string indicating the deployment status. It's either success or failed. |
28+
| Variable | Description |
29+
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+
| `$SK_NOW` | An ISO 8601 formatted time string. The time is computed when sending the webhook. |
31+
| `$SK_NOW_UNIX` | The unix timestamp. The time is computed when sending the webhook. |
32+
| `$SK_APP_ID` | The application id. |
33+
| `$SK_ENVIRONMENT` | The environment name. When triggering an outbound webhook on publish, this is the name of the environment that the deployment is published to. Otherwise, it is the name of the environment which the build configuration is taken from. |
34+
| `$SK_DEPLOYMENT_ID` | The deployment id. |
35+
| `$SK_DEPLOYMENT_ENDPOINT` | The endpoint to preview the deployment. |
36+
| `$SK_DEPLOYMENT_LOGS_ENDPOINT` | The endpoint to preview the deployment logs. You will need to be authenticated to visit this URL. |
37+
| `$SK_DEPLOYMENT_STATUS` | A string indicating the deployment status. It's either success or failed. |
3938

4039
</section>

public/sitemap.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
</url>
7575
<url>
7676
<loc>https://www.stormkit.io/docs/deployments/outbound-webhooks</loc>
77-
<lastmod>2024-08-02</lastmod>
77+
<lastmod>2024-11-04</lastmod>
7878
<changefreq>weekly</changefreq>
7979
<priority>0.6</priority>
8080
</url>

0 commit comments

Comments
 (0)