Using the Asynchronous Request Creation API

You can call OneTrust asynchronously from a published web form or external application to dynamically create a request that will appear in the Web Form Configuration screen.

Note:

This documentation uses the Postman tool to test API integrations.

To copy the API URL

  1. On the Privacy Rights Automation menu, select Web Forms. The Web Forms Templates screen appears.

  2. Click on a published web form. The Web Form Customization screen appears.
    Note:

    This feature is compatible only with published web forms. For more information on creating new web forms, see Creating a Web Form.

  3. Go to the Integrate tab, then click the API tab.


  4. Click the Copy URL button in the Your API URL block.


  5. In Postman, select POST from the endpoint field.
  6. Paste the Your API URL in the URL field.


To copy the API Token

  1. On the API tab in OneTrust, then click the Copy Token button in the Your API Token block.


  2. In Postman, click the Headers tab.
  3. Enter accessToken in the Key field.
  4. Paste the API token from OneTrust in the Value field.


To copy the Expected Payload

  1. On the API tab in OneTrust, click the Copy Expected Payload button in the Expected Payload block.
    Note:

    Any edits made to the web form fields will dynamically update in the expected payload.



  2. In Postman, click the Body tab.
  3. Enable raw as the preview type.
    Note:

    Ensure JSON is the selected file type.

  4. Paste the expected payload in the body.
    Tip:

    You can add the details of a request by editing the payload. Remove any additional parameters that you don't want to send to create the request or have null values (e.g. no attachments). The call won't send with null parameter values.



  5. Click the Send button.
  6. Verify the call was sent by checking the status code. If performed correctly, it should return a requestTraceId value.


  7. Copy the requestTraceId.

To verify the request in OneTrust

Note:

To reduce API calls and resource use when checking request status, use exponential backoff between polling attempts. Alternatively, configure an integration event for the request creation event in Workflow Settings to call a webhook to your system, eliminating the need to poll. For retries, include the original requestTraceId in the requestTraceId field of the request creation payload to help prevent duplicate requests.

  1. Create another call in Postman using the GET request status by Trace ID endpoint: GET /api/datasubject/v2/requestqueues/status/{traceId}
  2. Append the newly created requestTraceId to the end of the endpoint.


  3. In the Header tab, enter another API key.
  4. Click the Send button.
  5. If the call was successful, it will return a creationstatus:SUCCESS and a new requestReId.


  6. Return to OneTrust to see if the newly created request appears in the Request Queue with the matching requestReId.