3. HTTP routes - Twenty Documentation

The same handler can also answer HTTP requests. We’ll add two routes:

a POST endpoint the UI calls to generate a document, and
a public GET endpoint that renders a document as a printable web page.

Both use httpRouteTriggerSettings. App routes are served under /s on your Twenty server (e.g. http://localhost:2020/s/documents/generate).

POST route — generate on demand

This reuses generateDocumentHandler, so there’s no logic to repeat — just a thin adapter that reads the request body.

import { defineLogicFunction, type RoutePayload } from 'twenty-sdk/define';
import { Response } from 'twenty-sdk/logic-function';
import { generateDocumentHandler } from 'src/logic-functions/handlers/generate-document-handler';

const handler = async (event: RoutePayload): Promise<Response> => {
  const body = event.body as Record<string, unknown> | null;

  const result = await generateDocumentHandler({
    templateId: (body?.templateId as string) ?? '',
    recordId: (body?.recordId as string) ?? '',
  });

  // Map the handler's failure reason onto a real HTTP status (400/404/500)
  // instead of always returning 200.
  return new Response(JSON.stringify(result), {
    status: result.success ? 200 : (result.status ?? 400),
    headers: { 'Content-Type': 'application/json' },
  });
};

export default defineLogicFunction({
  universalIdentifier: GENERATE_DOCUMENT_ROUTE_UNIVERSAL_IDENTIFIER,
  name: 'generate-document-route',
  timeoutSeconds: 30,
  handler,
  httpRouteTriggerSettings: {
    path: '/documents/generate',
    httpMethod: 'POST',
    isAuthRequired: true,
  },
});

The shared handler returns a suggested status on failure, so the route can answer with a proper 4xx/5xx code. isAuthRequired: true means the caller must present a valid token — the front component in the next chapter passes the user’s access token automatically.

GET route — render as a web page

To return HTML instead of JSON, wrap the body in a Response with a Content-Type header. This route is public (isAuthRequired: false) so a generated document can be shared as a link.

import { defineLogicFunction, type RoutePayload } from 'twenty-sdk/define';
import { Response } from 'twenty-sdk/logic-function';
import { CoreApiClient } from 'twenty-client-sdk/core';
import { documentHtmlPage } from 'src/utils/render-document';

const htmlResponse = (html: string, status = 200): Response =>
  new Response(html, { status, headers: { 'Content-Type': 'text/html; charset=utf-8' } });

const handler = async (event: RoutePayload): Promise<Response> => {
  const documentId = event.queryStringParameters?.id;

  if (!documentId) {
    return htmlResponse(documentHtmlPage('Missing document id', 'Provide ?id=<documentId>.'), 400);
  }

  // Filtered list query so an unknown id renders a clean 404 page instead of throwing.
  const { documents } = await new CoreApiClient().query({
    documents: {
      __args: { filter: { id: { eq: documentId } }, first: 1 },
      edges: { node: { id: true, name: true, content: true } },
    },
  });

  const document = documents?.edges?.[0]?.node;
  if (!document?.id) {
    return htmlResponse(documentHtmlPage('Document not found', `No document with id ${documentId}.`), 404);
  }

  return htmlResponse(documentHtmlPage(document.name ?? 'Document', document.content ?? ''));
};

export default defineLogicFunction({
  universalIdentifier: VIEW_DOCUMENT_ROUTE_UNIVERSAL_IDENTIFIER,
  name: 'view-document',
  timeoutSeconds: 15,
  handler,
  httpRouteTriggerSettings: {
    path: '/documents/view',
    httpMethod: 'GET',
    isAuthRequired: false,
  },
});

documentHtmlPage renders the Markdown body to HTML (with marked, sanitized) and drops it into a clean, printable page that shows just the template content — the same look as the PDF and the in-app preview. See the helper.

Try it

With a template and a Person in your workspace, call the route (grab a token from Settings → APIs & Webhooks):

curl -X POST http://localhost:2020/s/documents/generate \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"templateId":"<templateId>","recordId":"<personId>"}'
# → {"success":true,"documentId":"...","content":"Dear Jeffery Griffin, ..."}

Open the returned document in your browser:

http://localhost:2020/s/documents/view?id=<documentId>

You can also stream a function’s logs while testing with yarn twenty dev:function:logs, or invoke it directly with yarn twenty dev:function:exec.

After this step: the app can generate documents over HTTP and serve them as web pages. Now let’s make it usable without curl.

Next: building the UI →

Views, navigation, a command, and a front component.

​POST route — generate on demand

​GET route — render as a web page

​Try it

Next: building the UI →

POST route — generate on demand

GET route — render as a web page

Try it