Slack Integration

Trunk allows you to create custom workflows to send customized messages to Slack through webhooks.

This guide will walk you through sending Slack messages using event-triggered webhooks. By the end of this tutorial, you'll receive Slack messages for test status changes. This guide should take 10 minutes to complete.

Want to chat with Trunk's engineers? Join us and 1500+ fellow engineers on Slack.

1. Create a new Slack app

You need to create a Slack app for your Slack workspace to receive webhooks from Trunk Flaky Tests.

1. Head to Slack API

2. Click Create New App to create a new app

3. This will open the Create an App modal. Select From scratch.

4. Fill in a display name for your Slack bot under App Name and select the Workspace to which the bot will post messages.

5. Click Create App. You will be redirected to your App's settings

2. Add a Webhook URL to Your Slack App In Trunk

For the new Slack app created, you need to enable incoming webhooks and add a webhook to your workspace.

1. In your Slack app's settings, under Features, navigate to Incoming Webhooks

2. Toggle Activate Incoming Webhooks

3. Click Add New Webhook to Workspace and select the channel messages should be posted in. Click Allow to add the new endpoint.

4. Copy the Webhook URL, such as https://hooks.slack.com/services/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

3. Configure Slack Webhook URL in Trunk

Trunk uses Svix to integrate with other services, such as Slack, through webhooks.

You can add the new Slack Webhook URL to Svix by:

1. Login to Trunk Flaky Tests

2. From your profile on the top right, navigate to Settings

3. Under Organization > Webhooks, in the Svix App Portal, click Add Endpoint

4. Paste the Webhook URL from Slack into Endpoint URL

5. Under Subscribe to events, select test_case.status_changed

6. Create the new endpoint. You will be redirected to the endpoint configuration view.

If you're having trouble adding a new webhook endpoint with Svix, please see the Adding Endpoint docs from Svix.

4. Add a Custom Transformation

Next, you need to create a custom transformation to turn the Trunk Flaky Tests event into a Slack message.

1. In the endpoint configuration view, navigate to the Advanced tab. Under Transformation, toggle the Enabled switch.

2. Click Edit transformation to create a custom transformation script.

3. Copy and paste the transformation script below and click Save. You can modify this script to customize your Slack message. You can find what's available in the webhook payload in the events reference.

4. You can test the transformation by selecting the test_case.status_changed payload and clicking Run Test. This will test the transformation but not send a message. You will learn to send a test message in step 5.

An example transformation script is provided below and you can customize your Slack integration by following the Slack and Svix transformations documentation.

/**
 * @param webhook the webhook object
 * @param webhook.method destination method. Allowed values: "POST", "PUT"
 * @param webhook.url current destination address
 * @param webhook.eventType current webhook Event Type
 * @param webhook.payload JSON payload
 * @param webhook.cancel whether to cancel dispatch of the given webhook
 */
function handler(webhook) {
  const payload = {"text": summarizeTestCase(webhook.payload)}
  
  webhook.payload = payload
  return webhook
}

function summarizeTestCase(payload) {
    if (!payload || typeof payload !== 'object' || !payload.test_case) {
        return "Error: Invalid or missing payload.";
    }

    const {
        test_case: {
            name = "N/A",
            file_path = "N/A",
            status = {},
            quarantine = false,
            repository = {},
            codeowners = [],
            failure_rate_last_7d = 0,
            most_common_failures = [],
            pull_requests_impacted_last_7d = 0,
            ticket = {},
            html_url = "N/A"
        }
    } = payload;

    const statusSummary = `Status: ${status.value || "Unknown"} `
        + `(Reason: ${status.reason?.trim() || "N/A"}, `
        + `Updated: ${status.timestamp ? new Date(status.timestamp).toLocaleString() : "Unknown"})`;

    const quarantineStatus = quarantine 
        ? "This test is currently quarantined." 
        : "This test is not quarantined.";

    const failureSummary = most_common_failures.map(failure =>
        `- ${failure.summary} (${failure.occurrence_count || 0} occurrences, `
        + `last seen: ${failure.last_occurrence ? new Date(failure.last_occurrence).toLocaleString() : "Unknown"})`
    ).join("\n");

    const repoLink = `Repository: ${repository.html_url || "N/A"}`;
    const testLink = `Test Details: ${html_url}`;
    const ticketLink = `Related Ticket: ${ticket.html_url || "N/A"}`;
    const ownerSummary = `Codeowners: \`${codeowners.join(", ") || "None"}\``;
    const statsSummary = `Failure rate (last 7 days): ${(failure_rate_last_7d * 100).toFixed(1)}% `
        + `| PRs Impacted: ${pull_requests_impacted_last_7d}`;

    return [
        `Test Name: \`${name}\``,
        `File Path: \`${file_path}\``,
        statusSummary,
        quarantineStatus,
        `Most Common Failures:\n${failureSummary}`,
        ownerSummary,
        statsSummary,
        repoLink,
        testLink,
        ticketLink
    ].join("\n");
}

5. Test Your Webhook

You can send test messages to your Slack channels as you make updates. You can do this by:

1. In the endpoint configuration view, navigate to the Testing tab and select a Send event

2. Under Subscribed events select test_case.status_changedas the event type to send.

3. Click Send Example to test your webhook

6. Monitoring Webhooks

You can monitor the events and the webhook's delivery logs in the Overview tab of an endpoint configuration view.

You can see an overview of how many webhook deliveries have been attempted, how many are successful, how many are in-flight, and how many fail in the Attempt Delivery Stats modal.

You can see a list of past delivery attempts in the Message Attempts modal. You can filter this list by Succeeded and Failed status, and you can click on each message to see the Message content, response code, and error message of each attempt. You can learn more about replaying messages and filtering logs in the Svix docs.

Congratulations!

You should now receive notifications in your Slack workspace when a test's status changes. You can further modify your transformation script to customize your messages.

See the Trunk webhook event catalog

Learn more about consuming webhooks in the Svix docs

Learn more about the Slack API