How to create and manage TEM webhooks

A webhook is an automated message sent in real-time from one system to another when a specific event happens, the message is typically conveyed using HTTP requests that are sent to an endpoint of your choice.

They can be used to track and respond to email-related events such as deliveries, bounces and spam. You can also trigger automated processes or alerts based on specific email events and sync your email events with CRM systems, analytics platforms, or other services.

You can set up webhooks for Scaleway Transactional Email and subscribe them to Scaleway Topics and Events to have real-time event alerts sent to your endpoints in the Scaleway console.

Before you startLink to this anchor

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization
• Configured your domain(s) with Transactional Email
• Added SPF, DKIM, MX and DMARC records to your domain(s)
• Have the necessary quotas to use Transactional Email Webhooks during beta. You can request quotas from the Scaleway betas page.

How to create a webhookLink to this anchor

1. Click Transactional Email in the Domains & Web Hosting section of the console side menu. Your domains display.
2. Click the domain for which you want to create a webhook.
3. Click the Webhooks tab.
4. Click + Create Webhook. The webhook creation wizard displays.
5. Complete the following steps:
   • Enter a name for your webhook.
   Note

   Webhook names must be between 3 and 127 characters.

   • Select an existing topic. Existing topics are displayed based on the region you select.
   Tip

   If you do not have a topic, you can create one with Scaleway Topics and Events from the console.

   • Choose the email events that will trigger the webhook and send information to your selected topic.
   Note

   Refer to the Transactional Email concepts page for a full list of available webhook event types.

6. Click Create Webhook to confirm. A list of your webhooks appears.

How to edit a webhookLink to this anchor

Once you have created webhooks, you can edit their settings anytime.

1. Click Transactional Email in the Domains & Web Hosting section of the console side menu. Your domains display.
2. Click the domain for which you want to edit a webhook.
3. Click the Webhooks tab.
4. Click «See more Icon» > Edit next to the name of the webhook you want to edit.
5. Update the settings according to your needs.
6. Click Update Webhook.

How to delete a webhookLink to this anchor

Once you have created webhooks, you can delete them anytime.

1. Click Transactional Email in the Domains & Web Hosting section of the console side menu. Your domains display.
2. Click the domain for which you want to delete a webhook.
3. Click the Webhooks tab.
4. Click «See more Icon» > Delete next to the name of the webhook you want to delete. A pop-up appears to warn that linked topic and subscriptions will stay available in Topics and Events.
5. Click Delete Webhook.