Create and verify an endpoint

To receive data, you must first verify your system's endpoint.

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 Endpoints tab.

   
4. Any created endpoints display. If you’re a new user, you should see a Redox API Endpoint already configured by default. You can use this for generating test requests. If you want to create a new endpoint, click the Create Endpoint button.

   Other methods or formats

   If you want to configure non-API destinations (i.e., endpoints for alternative communication methods or formats), navigate to the Others tab.

5. A new modal opens with a field for the endpoint name. Enter the name and click the Add button. 

   

   Endpoint region field

   If your organization is configured for multiple regions, an additional field displays for you to designate the region for the endpoint.

   If your organization is configured only for one region, this additional field doesn't appear.

6. The Settings page for the new endpoint opens. The Name field displays the endpoint name you entered previously. 
7. In the Redox API Endpoint field, enter the URL for this endpoint to receive data. The URL should use SSL/TLS encryption, which means it needs to start with https://.
8. In the Verification Token field, click the Change Token button. The Change Verification Token modal appears, which has a blank field for you to enter the verification token.

   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 use a unique, long alphanumeric string value that's difficult to brute force or guess.

9. After entering the verification token, click the Save Changes button. 
10. Your changes are saved and the Settings page displays again. In the Verification Method field, select either the GET or POST radio button. We recommend using POST if your endpoint allows it. However, GET can be used for verification too. 
11. When all of your information is entered, click the Verify & Save button in the bottom right corner.
12. We receive the verification token and send a test verification request to you. If you selected POST as the verification method, you receive a request with the following payload body:

    Example: POST verification token

    1
    {
    2
       "verification-token":"[your-verification-token]",
    3
       "challenge":"2e73f864-a0e9-4764-a7d5-91fe5836db22"
    4
    }

    If you selected GET as the verification method, you receive a request with this query string containing two values:

    Example: GET verification token

    1
    ?challenge=2e73f864-a0e9-4764-a7d5-91fe5836db22&verification-token=your-verification-token

13. To verify your endpoint and save your settings, you must first verify that the verification token matches the value you entered in Connection Settings. 
14. To complete the verification test, you must respond to the POST or GET request with the challenge value that we provided in the test. You can add the challenge value anywhere in the body of the response.

    Example: Challenge value

    1
    {
    2
       "challenge":"2e73f864-a0e9-4764-a7d5-91fe5836db22" 
    3
    }