Set up destinations

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

• A user must be assigned to an engineer role to manage destinations. Learn about user roles.
• For cloud destinations, decide on which supported cloud product(s) you’ll use. See our supported products.
• For standard URL endpoints, have your HTTPS endpoint URL ready.
• (Optional) Create an auth credential or verification token to authenticate incoming data. Otherwise, you can do this in the destination wizard.
• To delete a destination, you must be logged into a development or staging environment. Production destinations can’t be deleted without a Redoxer.

Follow these steps to view any existing destinations, or endpoints.

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 Destinations tab to view any configured destinations and auth credentials.
4. To view a specific destination’s configuration details, click the Edit button on its tile.

On the Destinations tab, click the New destination button to open the destination wizard. The instructions below take you through each step of the destination wizard.

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 setup at any time.

1. 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 more easily distinguish between destinations.

   
2. From the Destination type drop-down field, select whether your destination will be a standard URL endpoint or cloud type.
   • For standard URL endpoints, click the Next button to proceed to Step 2: Configure destination.
   • For cloud types, these drop-down fields appear:
     1. Cloud provider: Select the relevant cloud provider for your setup (i.e., AWS, GCP, or Microsoft Azure).
     2. Product type: Select the cloud product you’re using with the selected cloud provider.
     3. Click the Next button to proceed to Step 2: Configure destination.

        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.

        

1. In the Endpoint field, enter the URL endpoint. This must be an HTTPS URL.
2. Click the Next button to proceed to Step 3: Configure auth credential.

   

1. 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.
2. Click the Next button, then proceed to Step 4: Verify destination.

The Attach an auth credential drop-down appears.

1. Select the auth credential from the drop-down list.
2. Click the Next button to proceed to Step 4: Verify destination.

   

1. Click the plus (+) icon to the right of the field.

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

     Verification token

     The verification token is a value you decide. Treat it like a password. We recommend using a unique, long alphanumeric string value that’s difficult to brute force or guess.

     Redox uses that value in the verification-token header of every inbound request to your destination. Your system must check this header to verify the legitimacy of the inbound request.

   • 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.
3. Click the Next button to proceed to Step 4: Verify destination.

Skip verification

You can skip the verification step for production destinations if you don’t want test data in a production environment. Simply click the Skip verification checkbox, then click the Complete setup button to finish setting up your production destination.

1. 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 of development or staging destinations. 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.

1. Follow the steps to view destinations.
2. Find the destination you want to edit, then click the Edit button.
3. Use the Back and Next buttons to edit the configuration of the destination or auth credential.
4. When finished, click the Next button until you get the Verify step again.
5. Verify your endpoint, then click the Complete setup button to save your edits.

1. Follow the steps to view destinations.
2. 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.

   
3. A modal appears asking you to confirm the deletion. Click the Delete button to confirm—or the Cancel button if you changed your mind.