Outbound Webhooks

You can specify hooks to trigger certain actions upon certain events. To do so, head to your Application's Settings page and find the Outbound webhooks section. Outbound Webhooks Click Add new webhook to open the modal form. Create outbound webhook Fill out the form and click on Create outbound webhook button.

Special variables

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.

$SK_NOW An ISO 8601 formatted time string. The time is computed when sending the webhook.
$SK_NOW_UNIX The unix timestamp. The time is computed when sending the webhook.
$SK_APP_ID The application id.
$SK_DEPLOYMENT_ID The deployment id.
$SK_DEPLOYMENT_ENDPOINT The endpoint to preview the deployment.
$SK_DEPLOYMENT_LOGS_ENDPOINT The endpoint to preview the deployment logs. You will need to be authenticated to visit this URL.
$SK_DEPLOYMENT_STATUS A string indicating the deployment status. It's either success or failed.

Testing webhooks

Once a webhook is created you can test it by clicking on the ... > Trigger sample. The request status and body will be displayed in a modal.

Example webhooks

Discord

Request URL The webhook URL of the channel
Request Headers Content-Type: application/json
Request Method Post
Request Payload { "embeds":[ { "title":"Deployment completed", "timestamp":"$SK_NOW", "url":"https://www.stormkit.io", "fields":[ { "name":"App ID", "value":"$SK_APP_ID" }, { "name":"Status", "value":"$SK_DEPLOYMENT_STATUS" }, { "name":"Endpoint", "value":"$SK_DEPLOYMENT_ENDPOINT" }, { "name":"Logs", "value":"$SK_DEPLOYMENT_LOGS_ENDPOINT" } ] } ] }

Slack

Request URL Slack's webhook URL. Check out the documentation for more info.
Request Headers Content-Type: application/json
Request Method Post
Request Payload { "as_user": false, "username": "Stormkit", "icon_url": "https://bit.ly/3qqwmY0", "attachments": [ { "text": "Deployment completed: $SK_DEPLOYMENT_ENDPOINT", "color": "#36a64f", "footer": "Stormkit Webhooks", "ts": "$SK_NOW_UNIX" } ] }