Test an endpoint

Last updated: Jul 2, 2024

Testing an endpoint is useful to make sure an endpoint successfully receives expected data from Redox. This kind of testing is especially useful during onboarding to Redox or implementing with a new connection before going live. Our developer test tools in the Redox dashboard help you do just that. Our developer test tools comprise:

  • Notifications Explorer: Allows you to send test requests to a configured endpoint in your system.
  • Dev tool downloads: Contains useful downloads like Postman, OpenAPI, or CSV files to assist with your testing.

This guide is specifically for using the Notifications Explorer to test your endpoint(s).

  1. Log in to the dashboard.
  2. From the navigation menu, click the Developer page.
  3. By default, the Developer page opens and displays the API Keys tab. Click the Test Tools tab.
  4. By default, the Notifications Explorer displays. Select the Redox API you'd like to simulate notifications with by clicking either the Data Model API button or FHIR® API button.
  5. Select the configured endpoint you want to send test notifications to. You must have an endpoint configured in the Endpoints tab for it to appear in this drop-down menu.
  6. Select an option for credentials using the Send with Credentials toggle button. By default, your endpoints are set up using verification tokens. If this is the case, you can leave the Send with Credentials option toggled to OFF. Or, you may have an endpoint that uses more secure authentication credentials, which you can custom configure with the Platform API. If this is the case, toggle the Send with Credentials option to ON. Then select the custom configured credential from the drop-down menu that appears.
  7. Depending on which API you selected, a drop-down for the set of data models or FHIR® notifications displays. From the drop-down menu, select the data model or FHIR® notification you want to test.
  8. The Example drop-down appears. If there is more than one example available, you can select the example you want to use.
  9. Below the example field, the example payload displays. Make any modifications you want to the payload. Once you're finished reviewing or making changes, click the Send button.
  10. Below the Send button, a success or failed notification displays. The notification contains a link to the related log ID so you can view the details.
    Successful send
    Successful send
  11. (Optional) After successfully testing endpoints, you can also test sending outgoing requests to make sure your system can send the data your connection is expecting.