Test a destination

Testing a destination, or endpoint, in your Redox organization allows you to make sure you can receive data as expected from Redox. Typically, you test destinations during onboarding to Redox or implementing a new connection before go-live.

There are two Redox dashboard tools for testing your destinations:

• Notifications Explorer: Send test Redox data model or FHIR® messages to your configured destination(s). This tests your endpoint connectivity to simulate the Redox > destination part of your flow.
• Dataset Tester: Send test datasets to your configured destination(s). This tests your entire integration by simulating the source > Redox > destination flow. This is especially useful for cloud connectivity users. Learn more about cloud connectivity.

• You must have at least one destination already configured in order to test it. Learn how to set up destinations.
• Constraint: The rate limit when using any of our DevTools is lower than our standard rate limit. You can send up to 5 API requests per every 5 minutes with any of our test tools. Learn more about our quotas and constraints.

Use Notifications Explorer to check your endpoint connectivity and its ability to accept Redox formats (i.e., Redox data models or Redox FHIR®). This means simulating an individual message coming from Redox to one of your destinations (Redox > destination).

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the Sources tab opens. Click the Test Tools tab.
4. The Notifications Explorer opens. From the API drop-down, select either Data Model API to test receiving data model messages or FHIR® API to test receiving FHIR® notifications or messages.

   Reference links

   For data model specs, review our data model reference.

   For FHIR® message or notification specs, review our FHIR® notification reference.

5. From the Destination drop-down, select the existing destination you want to test. To create a new one, learn how to set up destinations.

   
6. The Send with credentials toggle allows you to override the destination’s configured auth credential or verification token for testing purposes. Learn about authenticating incoming data. Toggle to ON and select a different auth credential from the drop-down menu. Toggle to OFF to use the configured auth credential or verification token to authenticate the test message.

   
7. Depending on which API you selected, a drop-down for the set of data models or FHIR® messages and notifications displays. Select the type of test message to send.
8. Another drop-down may appear with examples. If there’s more than one example available, select the example you want to use.
9. The example payload appears. Make any modifications you want to the payload. Once you’re finished reviewing or making changes, click the Send button.
10. A success or failed notification appears. The notification contains a link to the related log ID so you can view the details.

    

    Log inspector not available

    Log inspector isn’t available for test messages sent through Notifications Explorer since this only simulates the Redox > destination portion of the flow. If your test message fails, check your destination’s configuration to make sure it was entered correctly.

Use Dataset Tester to validate that your destination can receive data in the raw format (e.g., HL7v2, C-CDA, X12) that your connection sends. This means simulating data coming from a source being processed by Redox then delivered to one of your destinations (source > Redox > destination).

This allows you to see the full breadth of how your subscription will work, since you’ll see how data will change from source to destination. This may help you make any necessary configuration changes before go-live.

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the Sources tab opens. Click the Test Tools tab.
4. The Notifications Explorer opens. Click the Dataset Tester toggle option.

   Staging or dev environments only

   You can’t use Dataset Tester in a production environment. This warning to switch to a non-production environment appears if you’ve selected Dataset Tester while in a production environment.

   

5. From the Dataset drop-down, select the relevant dataset type. We currently support sending one of these dataset types to one of your configured destinations:
   • HL7v2 ADT
   • C-CDA
   • X12 835
   • X12 837
6. From the Destination drop-down, select the existing destination you want to test.
7. Click the Send button.

   

   Rate limit error

   You receive an error message if you exceed the rate limit (i.e., sending more than 5 test datasets in 5 minutes). If you get an error, wait a few minutes and try again.

8. A success or failed notification appears. To view the logs, click the View logs link.
9. The Logs page opens with the appropriate filters applied so you can see all the logs that resulted from the full dataset. Review the outcome of the message in the log.

   

   Error notifications

   If a test dataset fails, the resulting error is either from Redox or your own system, since you own the destination. This gives you the opportunity to see what might fail and how your system handles those errors.

   To dig into any errors or unexpected mappings, run log inspector and review the error details in the Deliveries tab (under the Destination section). Then, make any necessary adjustments to your configuration(s).