GET /api/builder/preview/exchange/{token}/

Consume the preview pass, set a session cookie, and redirect the browser.

Invalid or expired tokens return 404 without creating a cookie. The requested redirect is accepted only when it points to the configured preview website; otherwise a safe preview root URL is used. Cookie security flags are selected according to whether the backend and preview website are considered the same browser site.

Servers

Path parameters

Name Type Required Description
token String Yes

The one-time builder preview token to exchange.

Query parameters

Name Type Required Description
redirect String No

The clean frontend preview URL to redirect to.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.