Using Webhooks

Beefree App is now RGE Studio!
The email design suite you already know and love just leveled up. We’re working hard to update our help center, but you still may see some references to the old product name.

Overview

Many companies and agencies use RGE Studio in their design workflows. Every team has its own needs. Most teams agree that real-time notifications are essential. RGE Studio provides in-app and email notifications. But what if you're not in the app or checking your email? That's where webhooks come in.

Webhooks enable you to send information one way from one platform to another. For example, you might use a project management tool and want to push design updates and comments to Asana, Jira, ClickUp, or Monday. You can also push those comments and updates to a Slack channel.

Many of our customers already have well-established procedures. Webhooks let you integrate RGE Studio into your existing workflow. For example, you can send notifications for new comments.

Getting Started

To get started with webhooks in RGE Studio, make sure you have the following:

• An RGE Studio Enterprise plan account
• Access to workspace settings permissions and a role of Owner, Admin, or Manager
• Access to a third-party automation tool, or a tool with webhooks functionality

Connecting a Third-Party Automation Tool

To get started with a third-party automation tool, take the following steps:

1. Select the automation tool that best suits your use case.
2. Create an account.
3. Create a new automation workflow.
   Note: These workflows have different names depending on the tool. At times they're referred to as "scenarios" or "zaps." Regardless of the name, the functionality of event trigger workflows remains the same.
4. Select "webhooks" as the first component in your workflow.
5. Copy and save your webhook URL. You'll need to enter it into your RGE Studio webhook settings later.
6. Select the notification platform you'd like to receive notifications through. Connect it to the webhook you created in the previous step.
   Note: For your notification platform, you can connect to a variety of tool options. Slack and Gmail are popular options.
7. Follow the steps in Creating a Webhook to connect your new workflow to RGE Studio.

Automating Notifications

Webhooks in RGE Studio let you automate notifications for comments or design status changes. Webhooks are specific to the workspace where you create them. The following sections cover both event triggers in more detail.

Comments

With webhooks, you can automatically push notifications for new comments on a design. The available trigger events for comments are the following:

• New replies
• Replies
• Mentions
• Resolved comments

You can include any of the following data fields in your custom notifications.

The following image shows an example of a webhook component within the tool Make. The screen shows the data details from a comment event trigger within RGE Studio, and the option to customize a notification using the RGE Studio data details.

Design Status Updates

With webhooks, you can automatically push notifications when the design status changes. The available trigger events for design status are the following:

• Draft
• In review
• Approved

The tool receiving the data lets you customize the notification format.

You can include any of the following data fields in your custom notifications.

Example Notification

You have many options for customizing your notifications. You can send them to almost any platform your tool supports.

The following is an example notification created with webhooks. You can see how we're using incoming data fields to create the notification.

Hi there!

User_name added a event_type on date to a workspace you manage. Check out the change they made and the new workspace activity at design_url. Happy designing!

RGE Studio Notification

Creating a webhook

1. Navigate to the Webhooks tab in your workspace settings.

2. Click Create a new webhook. If you already have a webhook set up, you'll see a button that says Create new instead.

   

3. Fill out all the fields in the modal.

   

• Name - Enter whatever name you'd like to help you identify this webhook.
• URL destination - This information is provided by the third-party application. It's the URL the webhook sends requests to.
• Trigger event - Use the dropdown to select Comments or Design Status notifications.

We recommend using the Test button to make sure your external tool receives the updates. A green checkmark will appear in the textbox if the test is successful.

Once you're done, click Create webhook. You'll start receiving notifications right away.

Edit a webhook

If you need to edit an existing webhook, click the pencil icon to the right of your webhook details.

You can modify any of the fields for your webhook, or test the URL again. Click Save to save your changes.

Delete a webhook

To delete a webhook, click the red trash icon. A modal will appear, asking you to confirm the deletion.

Click Delete to confirm. Deleting a webhook may affect your external workflows, so review your automations first.