Note: Using third-party tools
This article covers features and steps that involve third-party tools.
Based on our Studio.Design Support Policy, questions about specifications or behavior beyond the steps described in this article may fall outside the scope of chat support.
Notification overview
Studio.Design sends webhook notifications at the following times:
You can set only one URL per project for webhooks.
Turn on webhooks
Follow these steps to set up webhook notifications:
Sign in to Studio.Design.
Open the dashboard for the project you want to set up.
Click [Home] > [Project Settings].
Scroll down the Project Settings screen and click the edit icon
next to [Webhook] at the bottom.Enter the endpoint URL of the system where you want to receive notifications, then click [Save] to turn on the webhook.
After it's turned on, click [Send Test] to make sure it's working.
Turn off webhooks
To stop notifications, follow these steps:
Sign in to Studio.Design.
Open the dashboard for the project you want to update.
Click [Home] > [Project Settings].
Scroll down the Project Settings screen and click the edit icon
next to [Webhook] at the bottom.Clear the endpoint URL field and click [Save].
Once saved, the status changes to OFF, and the webhook is turned off.
How it works
When the notification conditions are met, Studio.Design sends a POST request to the URL you set, with the following details:
Content-Type: application/json
User-Agent: Studio-Webhook
Body: {JSON}
Example of the JSON that gets sent:
*Line breaks are shown here for readability. In practice, the JSON is sent on a single line with no spaces between property names and values.
{
"project_id": "xxxx",
"project_name": "Test project name",
"event": "site-published",
"user_id": "xxxx",
"user_name": "xxx xxx",
"dashboard_url": "https://app.Studio.design/projects/xxxxx",
"publish_url": "https://example.com",
"timestamp": 1711582925
}
Here's what each field means:
Property name | Description |
project_id | Unique ID that identifies the project |
project_name | Name of the project |
event | Name of the notification event. One of: site-published, site-updated, or site-unpublished |
user_id | ID of the user who performed the action |
user_name | Name of the user who performed the action |
dashboard_url | URL of the corresponding Studio.Design project dashboard |
publish_url | URL of the published site |
timestamp | Time the event occurred, in UNIX timestamp format |
Using a Slack incoming webhook
When you register a Slack incoming webhook URL in Studio.Design, notifications are automatically sent to Slack based on the event type.
Slack notifications are shown in the language set by the Studio.Design user who configured the webhook.
For details on how to set this up, see Slack Developers > Slack API Client > Incoming Webhooks (external link).
Example notifications (when a site is published, updated, or unpublished):
