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 Developer page opens and displays the API Keys tab. 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.
  5. A new modal opens with a field for the endpoint name. Enter the name and click the Save button. 
  6. Your new endpoint now appears on the Endpoints tab. Click the Edit button of the endpoint you want to configure.
  7. The endpoint details page opens. Under the endpoint name, click the Settings tab.
    Endpoint settings
    Endpoint settings
  8. All Settings fields display.  The endpoint name you entered previously displays in the Name field.  The Communication Method field is disabled because the only supported option for an endpoint is the Redox API option.   The Format field is disabled because the only supported option for the Redox API is the JSON option.

    Other methods or formats

    If you want to configure endpoints with different communication methods or formats, navigate back to the Developer page and select the Others tab.

  9. In the 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://.
  10. 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 is difficult to brute force or guess.

  11. After entering the verification token, click the Save Changes button. 
  12. 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. 
  13. When all of your information is entered, click the Verify & Save button in the bottom right corner.
  14. 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:
    If you selected GET as the verification method, you receive a request with this query string containing two values:
  15. To verify your endpoint and save your settings, you must first verify that the verification token matches the value you entered in Connection Settings. 
  16. 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.