Integration 

Download 

JSON

The complete report document. The screenshot is embedded as base64 in attachments[].contentBase64.

Markdown

A readable version for tickets and chats, without the screenshot.

JSON and Markdown downloads are recorded in the delivery history.

After sending a report, the reporter can copy a short text summary, the Markdown version, the link to the report and the JSON document to the clipboard; administrators can do the same in the report history. The copied JSON has the same schema, but no contentBase64: screenshots are only included in the downloaded file.

The Markdown version escapes the title, description and other text that users entered, so it cannot add images, links, HTML or structure to a ticket. URLs in user text are shown as code.

Email 

Emails are plain text and sent with the TYPO3 mail API and its configured transport. The subject and the body template contain markers such as {report.title}. Unknown markers are left untouched. The screenshot and the JSON report can be attached. The header X-Context-Reporter-Report contains the report ID; test emails carry X-Context-Reporter-Test: 1 instead. See Email status and test email if emails do not arrive.

Webhook 

The webhook sends an HTTP POST request with a JSON body.

POST /your/endpoint HTTP/1.1
Content-Type: application/json; charset=utf-8
User-Agent: TYPO3-Context-Reporter/0.2.0
X-Context-Reporter-Event: report.created
X-Context-Reporter-Report: CR-CR91-A84Z-DA59
X-Context-Reporter-Delivery: 7dd6d20a-ee21-4107-be2e-5767269320d2
X-Context-Reporter-Attempt: 1
X-Context-Reporter-Timestamp: 1789565415
X-Context-Reporter-Signature: t=1789565415,v1=5b0c…
Authorization: Bearer …

The signature header is only sent when webhook.secret is set. The authentication header is only sent when webhook.authHeaderValue is set.

{
  "event": "report.created",
  "delivery": {
    "id": "7dd6d20a-ee21-4107-be2e-5767269320d2",
    "attempt": 1,
    "sentAt": "2026-09-16T13:30:15+00:00"
  },
  "report": {
    "schema": "context-reporter.report.v1",
    "id": "CR-CR91-A84Z-DA59",
    "createdAt": "2026-09-16T13:30:15+00:00",
    "source": "formEngine",
    "title": "Media field shows no files",
    "description": "I opened the content element and the image selector stays empty.",
    "summary": "Page Content \"Our story\" [tt_content:2] (Text & Media) on page \"About us\" [2] · site main · language English · workspace Live · editing form",
    "subject": {
      "type": "record",
      "table": "tt_content",
      "uid": 2,
      "label": "Our story",
      "typeLabel": "Text & Media",
      "backendUrl": "https://www.example.com/typo3/record/edit?edit%5Btt_content%5D%5B2%5D=edit"
    },
    "project": { "name": "Example", "identifier": "example", "environment": "Production", "backendUrl": "https://www.example.com/typo3/" },
    "reporter": { "uid": 3, "username": "editor" },
    "context": {
      "backend": { "route": { "identifier": "record_edit", "path": "/record/edit" }, "backendLanguage": "en" },
      "page": { "uid": 2, "pid": 1, "title": "About us", "slug": "/about-us", "doktype": 1, "doktypeLabel": "Standard", "hidden": false },
      "record": {
        "table": "tt_content",
        "tableTitle": "Page Content",
        "uid": 2,
        "pid": 2,
        "label": "Our story",
        "type": { "field": "CType", "value": "textmedia", "label": "Text & Media" },
        "languageId": 0,
        "colPos": 0,
        "hidden": false
      },
      "formEngine": { "mode": "edit", "records": [{ "table": "tt_content", "uid": 2 }] },
      "site": { "identifier": "main", "base": "https://www.example.com/", "rootPageId": 1 },
      "language": { "id": 0, "title": "English", "locale": "en-US" },
      "workspace": { "id": 0, "title": "Live" },
      "visibility": {
        "evaluatedAt": "2026-09-16T15:30:15+02:00",
        "subject": { "reasons": [] },
        "page": { "uid": 2, "title": "About us", "reasons": [] },
        "translations": [
          { "languageId": 1, "title": "Deutsch", "page": { "exists": true, "reasons": [] }, "record": { "exists": true, "reasons": ["hidden"], "hidden": true } }
        ]
      },
      "fileChecks": {
        "references": {
          "checked": 2,
          "notChecked": 1,
          "problems": [
            { "field": "assets", "fieldLabel": "Media elements", "reference": 7, "file": { "uid": 12, "name": "team.jpg" }, "problems": ["hidden"] }
          ]
        }
      }
    },
    "system": { "typo3Version": "14.3.7", "phpVersion": "8.3.33", "applicationContext": "Production" },
    "browser": { "summary": "Chrome 148 · macOS · 1440×900", "language": "en-US" },
    "attachments": [
      {
        "type": "screenshot",
        "filename": "CR-CR91-A84Z-DA59-screenshot.png",
        "mediaType": "image/png",
        "size": 102939,
        "width": 1440,
        "height": 900,
        "sha256": "5f03…",
        "contentBase64": "iVBORw0KGgo…"
      }
    ],
    "links": { "report": "https://www.example.com/typo3/module/system/context-reports/show?report=CR-CR91-A84Z-DA59" },
    "generator": { "name": "TYPO3 Context Reporter", "package": "priebera/typo3-context-reporter", "version": "0.2.0" }
  }
}

Notes on the report document:

• source is toolbar, contextMenu, formEngine, recordList, pageModule or fileList. subject.type is backend, page, record, file or folder. Files and folders have a combined subject.identifier, for example 1:/user_upload/logo.png.
• project, reporter, system and browser are omitted when there is nothing to share. context only contains the sections that apply, for example page, record, file, folder, storage, formEngine, site, language, workspace, backend and recentErrors.
• context.visibility (pages and records) lists the stored settings that decide whether TYPO3 shows the object to website visitors, see Visibility settings. subject, page, the entries of parentPages.restricting and the page and record entries of translations have reasons (hidden, scheduled, expired, accessRestricted) and the facts behind them: hidden, starttime and endtime (ISO 8601), frontendGroups (id and title; -1 hides the object for logged-in visitors, -2 shows it to logged-in visitors only), frontendGroupsNotListed, hiddenInMenu and workspaceState (unchanged, new, changed, deleted; only in a workspace). Translations have exists and, for disabled site languages, enabled: false. parentPages is only present if the reporter may edit Extend to subpages; checkedUpToRoot is false when parent pages outside the reporter's access were not read. These are stored settings, not a check of the rendered website. Reports created before version 0.2 have no visibility section.
• context.fileChecks lists file problems TYPO3 knows about, see File checks. For a reported file, file has storageCheck (found, notFound, or notChecked when the storage is offline or could not be asked) and problems; for file metadata, file also has the uid and name of the file it describes. For a reported page or record, references covers the file fields its type shows, for a reported file reference that reference: checked and notChecked count the references (files the reporter may not read are only counted), problems lists at most ten references with field, fieldLabel, reference (UID of the file reference), file (uid and name; missing when the file no longer exists) and their problems; problemsNotListed and overLimit (references beyond the first 100) follow when needed. Problems are missing (marked as missing in the file index), notInStorage (reported file only), storageOffline, empty, hidden (file reference) and brokenReference. The section is omitted when nothing could be checked. Reports created before version 0.2 have no fileChecks section.
• New fields can be added in later versions. Receivers should ignore unknown fields.
• Backend links contain no tokens. Users who are not logged in are asked to log in first.

{
  "event": "test",
  "delivery": { "id": "0b8e6f58-7f55-4d86-8a1b-5d8f1e7c2a10", "attempt": 1, "sentAt": "2026-09-17T09:00:00+00:00" },
  "test": {
    "message": "Test delivery from TYPO3 Context Reporter. It does not contain a report.",
    "project": { "name": "Example", "identifier": "example", "environment": "Production" },
    "reportSchema": "context-reporter.report.v1"
  },
  "generator": { "name": "TYPO3 Context Reporter", "package": "priebera/typo3-context-reporter", "version": "0.2.0" }
}

function isValidContextReporterRequest(string $body, string $header, string $secret): bool
{
    if (!preg_match('/^t=(\d{1,12}),v1=([a-f0-9]{64})$/D', $header, $matches)) {
        return false;
    }
    if (abs(time() - (int)$matches[1]) > 300) {
        return false;
    }
    $expected = hash_hmac('sha256', $matches[1] . '.' . $body, $secret);
    return hash_equals($expected, $matches[2]);
}

$valid = isValidContextReporterRequest(
    file_get_contents('php://input'),
    $_SERVER['HTTP_X_CONTEXT_REPORTER_SIGNATURE'] ?? '',
    getenv('CONTEXT_REPORTER_WEBHOOK_SECRET'),
);

import { createHmac, timingSafeEqual } from 'node:crypto';

function isValidContextReporterRequest(rawBody, header, secret, toleranceSeconds = 300) {
  const match = /^t=(\d{1,12}),v1=([a-f0-9]{64})$/.exec(header ?? '');
  if (!match || Math.abs(Date.now() / 1000 - Number(match[1])) > toleranceSeconds) {
    return false;
  }
  const expected = createHmac('sha256', secret).update(`${match[1]}.`).update(rawBody).digest();
  return timingSafeEqual(expected, Buffer.from(match[2], 'hex'));
}