Skip to main content

Test API integrations with the triage tool

Updated over 2 months ago

The Integration Triage Tool helps you test and troubleshoot API integrations from the Preview page—before you launch your experience. This allows your team to validate and debug integrations without publishing the campaign or affecting reporting and live data.

Before you begin

  • Have an experience that's almost ready to go. We recommend you always test your integration before publishing a campaign to avoid errors and incorrect data in live sessions.


Test your integration

  1. Open the campaign and click the Preview tab (not the full-screen preview).

  2. Select the Test API Integration icon from the top-right and a window slides out. This allows you to run test submissions without publishing the campaign.

    1. The preview URL will update to reflect test mode.

    2. If no integrations are detected, the panel will show an empty state.

    3. Closing the panel exits test mode automatically.

  3. Select your integration from the dropdown. If multiple integrations are configured, choose the one you want to test. The panel displays the integration name and current status.

    1. We recommend a consistent naming convention for integrations to make them easy to identify across teams.

  4. Walk through the experience as a user and submit the experience. Submissions will be routed through the selected integration in test mode. It may take up to one minute for the payload to appear.

    1. Test data is excluded from reporting.

  5. The integration will run and it's success will show under Status. Once done, the panel displays integration feedback including:

    1. Payload status: In Progress, Successful, or Failed

    2. Payload request: The full data sent (sensitive values like API keys are masked)

    3. Integration response: Status and any error messages from the receiving system

  6. If a test fails, use the error message and response details to quickly identify and fix the issue. Refer to your end system’s API documentation to understand expected success responses.

  7. Use Copy to Clipboard to export the request and response. Share these with your engineering team or Jebbit Support for further investigation if needed.


Troubleshoot common errors

Authentication errors

Review the request and response logs in the triage panel. For example, a "Missing or invalid private key" error means the key provided is incorrect or missing. Update the key to resolve.

Vendor-specific errors

Vendor API responses can help pinpoint problems with the integration. Share the full request and response with your development team for investigation.

Missing attribute mappings

If expected data is missing from the payload, verify that the corresponding attribute is correctly mapped within your campaign.

Errors without request/response detail

If the triage panel shows a failed submission without a visible request or response, contact Support for assistance.

Did this answer your question?