Manage destinations

You must set up standard endpoint(s) and/or cloud destination(s) to receive data from Redox. Learn more about receiving data.

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the API Keys tab displays. From the tab options, click the Destinations tab.
4. Any configured destinations, or endpoints, display. Click the New destination button.
5. The destination wizard opens. Enter a human-readable name for the destination. This will be the display name on the Destinations tab.

   Destination names

   There aren't any restrictions around destination names. That means you could end up with duplicate names.

   We recommend creating unique, descriptive names so you can distinguish between your destinations in the dashboard.

   Save progress and exit

   You can exit the destination wizard at any time. If you've already started entering destination settings, you can click the Save Progress option to save what you've done so far and exit the wizard.

   

   The new destination will appear on the Destinations tab with a status of in progress. Edit the destination to complete the setup at any time.

   

6. From the Destination type drop-down field, select whether your destination will be a standard URL endpoint or cloud type.
   1. For standard URL endpoints, click the Next button. Jump to the standard URL endpoint instructions to configure your destination.
   2. For cloud types, more fields appear before you can click the Next button. Jump to the cloud destination instructions for details.

      

1. In the Endpoint field, enter the URL endpoint. This must be an HTTPS URL.
2. Click the Next button.

   Can't edit destination types

   After completing the first two steps in the destination wizard (i.e., destination type and configuration details), the destination type fields become uneditable. Even if you click the Back button or Edit button later, the destination type fields will be read-only. The destination configuration details can still be edited, however.

   If you need to edit a destination's type or cloud product(s), we recommend deleting the existing one and creating a new destination instead.

   
3. The Attach an auth credential drop-down appears.
   1. To use an existing auth credential, select the auth credential from the drop-down list.

      
   2. To create a new auth credential or use a verification token, click the plus (+) icon to the right of the field.

      
      1. Radio options appear. Select the Verification token or Auth credential radio button, depending on which authentication method you want to use for your destination.
         1. Verification token: Enter the verification token in the blank field.

            Verification token

            The verification token is a value that you decide and Redox uses in the header of any request you receive to verify that the request is from a legitimate endpoint. Treat it like a password. We recommend you using a unique, long alphanumeric string value that's difficult to brute force or guess.

         2. Auth credential: Enter a unique, human-readable name, then fill out the rest of the configuration depending on your selected auth strategy. Learn how to create an auth credential.
4. Click the Next button.
5. Jump to the verification section.

1. After selecting cloud type, the Cloud provider drop-down field appears. Select the relevant cloud provider for your setup (i.e., AWS, GCP, or Microsoft Azure).
2. From the Product Type drop-down field, select the cloud product you're using with the selected cloud provider.

   
3. Click the Next button.

   Can't edit destination types

   After completing the first two steps in the destination wizard (i.e., destination type and configuration details), the destination type fields become uneditable. Even if you click the Back button or Edit button later, the destination type fields will be read-only. The destination configuration details can still be edited, however.

   If you need to edit a destination's type or cloud product(s), we recommend deleting the existing one and creating a new destination instead.

4. Depending on your selected cloud provider and product type, the set of configuration fields will be different. Check out the relevant how-to for your cloud setup. You'll find details about auth credentials in each of these how-tos as well.
5. Click the Next button.
6. Jump to the verification instructions.

1. The Verification step opens. In the Data Model drop-down, select a test data model or FHIR® message you support and plan to receive.

   FHIR data model format

   If you're sending data to a cloud FHIR® store, you should pick a data model that starts with FHIR®.Event.<FHIR®-resource-or-notification>.

2. Click the Send button. This triggers a sample message to verify that your destination can receive the expected data from Redox.
3. If the test message is successful, you should receive a 200 response. Click the Complete setup button to close the wizard. If the test message isn't successful, you won't be able to finish the setup. Make sure your endpoint URL adheres to Redox requirements, then try again. Otherwise, check out verification troubleshooting tips.

   Endpoint requirements

   To successfully exchange data, your endpoint(s) must:

   • be publicly accessible from the internet;
   • accept POST requests;
   • use SSL/TLS encryption (not relevant to development environments); and
   • check the verification token of every incoming request.

Skip verification

For production destinations, you can skip the verification step if you don't want test data in a production environment. All you have to do is click the Skip verification checkbox. Then click the Complete setup button to finish your production destination setup.

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the API Keys tab displays. From the tab options, click the Destinations tab.
4. Any configured destinations, or endpoints, display. Find the destination you want to edit, then click the Edit button.
5. Use the Back and Next buttons to edit destination or auth credential configuration.
6. When finished, click the Next button until you get the Verify step again.
7. Verify your endpoint, then click the Complete setup button to save your edits.

Follow these steps to delete an API destination. Or, learn how to delete a non-API destination.

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Developer page.
3. By default, the API Keys tab displays. From the tab options, click the Destinations tab.
4. Any configured destinations, or endpoints, display. Find the destination you want to delete, then click the Delete button.

   Can't delete production destination

   You can’t delete a production destination without a Redoxer’s help. Talk to your Technical Account Manager if you need to delete a destination in a production environment.