Integrations & automation

# Test an integration

Save sample input with the expected output or assertions, run the tests whenever you change an integration and get warned when a test fails.

Updated October 4, 2026

**Who can do this:** Role level 800 or higher and the integration permission.

An integration test feeds a fixed piece of sample data through one data source of an integration and checks the result. Save tests for the cases that matter, such as an order with several stops or a cancellation, and run them after every change to the mapping.

## Add a test

1. Open the side menu (☰, top right), choose **Integrations** and click the integration.
2. Click the **Tests** tab.
3. Click **\+ Add test**. The **New test** form opens.
4. Enter a **Name** and, optionally, a **Description**.
5. Choose the **Data source** the test runs through.
6. Paste the sample data in **Input (JSON)**.
7. Choose how the result is checked in **Validation** (see below).
8. Fill in **Expected output (JSON)**, the **Validation assertions**, or both.
9. Click **Save**.

## How a test is checked

* **Exact output match**: the output must be exactly the expected output.
* **Assertions only**: only the assertions are checked. Use this when the output contains values that change, such as dates.
* **Expected output and assertions**: both must pass.

To add an assertion, click **\+ Add assertion** and fill in an **Assertion name**, the **Field path (leave empty for the whole output)**, for example `$.shipment.reference`, a comparison and a **Value**. Set the **Severity**: **Error — fails the test** or **Warning — reported only**.

## Run tests

* Click **Run** on a test to run it, or **Run all** to run every test of the integration.
* Each test shows **PASS**, **FAIL** or **NOT RUN** and the time of the **Last run**.
* Open a result to compare the **Actual output** with what you expected. Failed assertions show what was expected and what came out.

## Edit or delete a test

* Click the pencil (✎) on the test to open **Edit test**, change it and click **Save**.
* Click the bin icon and then **Confirm delete** to delete it, or **Cancel** to keep it.

## Get warned when a test fails

In the test form, **On failure** decides who hears about a failing test. **Send a notification on failure** and **Send an email on failure** can each be **Use platform default**, **Yes** or **No**. Choose users in **Notify these users** and enter addresses in **Email recipients (comma separated)**.

The platform default is set by an administrator under **Settings** \> **Environment** \> **Integrations** \> **Integration test failures**. There you can also choose **Only notify when a test changes from passing to failing**, so a test that keeps failing does not send the same message again.

## Related articles

* [Monitor an integration](/en-us/help/integration-logs)
* [Build a self-configurable integration](/en-us/help/self-configurable-integration)
* [Connect other systems with integrations](/en-us/help/integrations)

## Still need help?

Our support team is happy to answer any question about Transportial.

[Contact support](/en-us/contact)[Report an issue](/en-us/report-issue)

---
Canonical page: https://transportial.com/en-us/help/integration-tests