Test an API integration

Quickly run tests on your API integrations in your NLX workspace

Access

To access this feature, select the API resource where your integration set up exists:

• Select Test option in upper right of resource's page

• Click Run test on panel

Toggle on Dynamic setting under applicable Headers to test Dynamic headers in your test.

---

Testing a data request

Quickly confirm your data request is set up and configured properly by using the Test feature:

Sample setup:

Request

 curl -X POST 
https://nbd1ntgf7l.execute-api.us-east-1.amazonaws.com/v2/webhook
 -H 'content-type: application/json' -d '{ "variables": [{ "variableId": "Profile", "payload": { "email": "
[e-mail]
" } }] }'

Expected Response

{
  "resolvedVariables": [
    {
      "variableId": "Profile",
      "value": {
        "id": "1234",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[e-mail]"
      }
    }
  ],
  "unresolvedVariables": [],
  "context": { "KEY1": "VALUE1", "KEY2": 1234 }
}

The sample endpoint should receive a POST request with a body that sends the variableId and payload attribute. The response returns the resolvedVariables attribute with variableId variable and value object that can be mapped

• Select Response model tab > Select the type of object returned. In this example, the value attribute returns an Object with attributes firstName, lastName, and id

• Select Request model tab > Add the payload field. In this example, the payload field is email

• Click the Implementation tab and switch to External mode > Add the URL for the endpoint in the URL field

• Add the necessary headers, if applicable. Some webhook endpoints need an API key. For this example, none is needed

• Click Save

• Click Run Test to test the endpoint

The response should look identical to your expected response, indicating a successful setup.