Study guide · Backend Modules and Automation

Backend modules and automation in TYPO3 14

As of November 16, 2026 · TYPO3 14.3 LTS · about 25 min read

This page covers the backend modules an integrator uses in TYPO3 14 to prepare changes safely, move page trees, find broken links and automate tasks. On top of that come reactions, webhooks and the command line.

The example and the modules

The integrator Mara is building the website of the Lindenau music school with TYPO3 14.3. The new term programme is prepared in a workspace, the scheduler checks the links at night, and a ticket system and a newsletter service are connected.

Since TYPO3 14, many modules have new names:

  • Under Content you find Publish for workspaces, Status, formerly Info, and the Recycler.
  • Under Sites there is Link Management, where the link validator is called Check Links.
  • Under Administration you find Reports, the Scheduler and Integrations with reactions and webhooks.
  • Under System there is Maintenance, the maintenance area from the Install Tool.

Workspaces: preparing changes safely

The term programme should only go online on the first of September, all pages at once. That is what workspaces are for. Content edited in a workspace stays separate from the live website until someone reviews and publishes it. When you change something in a workspace, TYPO3 creates a new version of the record. The live version stays untouched.

Workspaces are core functionality. They come with the system extension workspaces, in a Composer project the package typo3/cms-workspaces.

The normal working environment is the LIVE workspace. Whatever you save there is visible immediately. You create custom workspaces as records of the type Workspace on the root node, the top level of the page tree. You switch between them with the workspace selector in the sidebar. The module Content > Publish lists all changes in the current workspace, and there you send them on, discard them or publish them.

Preview links let people without backend access look at the workspace, for example the head of school. By default, such a link is valid for 48 hours. The duration is set on the workspace in the field for the preview link lifetime. If it is 0, the User TSconfig option options.workspaces.previewLinkTTLHours applies, which also defaults to 48. Since TYPO3 14.2, preview links work not only for pages but for all record types.

Setting up workspaces: roles, stages and publishing

A custom workspace has two roles. Owners have all rights in the workspace, including publishing. Members may edit, but you can stop them from publishing. Administrators have access to all workspaces anyway.

Access to LIVE: Once the workspaces extension is installed, editors may only work live if this is explicitly allowed. The checkbox is called “Edit Live (Online)” in the field Workspace permissions on the user or the group. It is preset for new users, but not for groups. For anyone who should only work in the workspace, Mara removes it.

Mount points: A workspace can be restricted to certain parts of the page tree. If the workspace has no mount points, those of the users and their groups apply.

Stages: By default, every custom workspace has the stages Editing and Ready to publish. After that comes only publishing itself. Whenever a change moves to another stage, the people involved can be notified by email.

The school wants its head to review every fee schedule before it goes online. Mara maps it with a custom stage. You add custom stages on the workspace in the tab Custom Stages. You can add as many as you like and order them freely, but they always sit between Editing and Ready to publish. For each stage, you pick responsible persons from the owners and members. They are notified when changes reach their stage.

Editing editorial team Review head of school Ready to publish LIVE online custom stage notification Custom stages always sit in between. Publishing date set? Cron job Scheduler task workspace:autopublish publishes only what has reached Ready to publish
Custom stages always sit between Editing and Ready to publish.

Normally, anyone with publishing rights may publish from any stage. Two settings in the tab Publishing Access on the workspace change this.

  • “Publish only content in publish stage” allows publishing only for content that has reached Ready to publish.
  • “Restrict publishing to workspace owners” limits publishing to the owners.

With both together, not even an owner can skip the review. In the same tab, you can allow records from tables without versioning to be edited in the workspace. Such changes take effect live immediately, without review.

Publishing on a set date: In the same tab, Mara enters a publishing date, the first of September. On that day, TYPO3 publishes everything that has reached Ready to publish. Content in earlier stages stays behind. But this only works if the scheduler runs the task for it.

The documentation names two scheduler tasks of the workspaces extension. “Workspaces auto-publication” publishes workspaces whose date has come. “Workspaces cleanup preview links” deletes expired preview links from the table sys_preview. In TYPO3 14, these are the console commands workspace:autopublish and cleanup:previewlinks. In the scheduler, you plan them with the task “Execute console commands”.

Importing and exporting page trees

Mara wants to move the holiday course pages from a test installation to the real one. The system extension impexp exports page trees and records and imports them into another installation. Exports are created as XML or as T3D, optionally as a compressed T3D file. Both formats can be imported again.

Who may do this? By default, import and export are only available to administrators. For other users, you enable each one separately in User TSconfig, with enableExportForNonAdminUser and enableImportForNonAdminUser under options.impexp. An export can contain sensitive data, and an import can change a lot. So only grant this where it is needed.

options.impexp.enableExportForNonAdminUser = 1
User TSconfig example. The option enableExportForNonAdminUser under options.impexp is set to 1, so that an editor may export.

Export: Mara opens the context menu of the holiday courses start page in the page tree and selects Export. Important settings are:

  • Levels sets the depth. With “Infinite”, all subpages are included.
  • Include tables selects the tables whose records on these pages are exported, such as content elements.
  • Include relations to tables adds referenced records, even if they are stored elsewhere.
  • Use static relations for tables keeps references without exporting the related record.
  • Exclude disabled elements leaves out hidden elements.

Static relations are handy for categories. The courses are linked to categories that already exist in the target installation. So Mara sets static relations for sys_category. The links are kept, but the categories themselves are not exported. This only works if they exist in the target with the same UID.

Import: In the target installation, Mara selects Import in the context menu of a page, uploads the file ending in t3d or xml and runs the import. The option Update records overwrites existing records with the same UID instead of creating new ones, for example when restoring into the same installation.

Finding broken links with the link validator

The link validator searches fields for links and reports targets that can no longer be reached. In the backend it sits under Sites > Link Management > Check Links. There you can also start a check by hand and see the report.

You configure it in Page TSconfig under mod.linkvalidator. Because Page TSconfig is inherited, the settings also apply to all subpages. The most important keys:

  • searchFields sets which fields are searched. The defaults include link of pages, bodytext and header_link of content elements and target of redirects in sys_redirect.
  • linktypes sets the kinds of links. Since TYPO3 13, it only lists db and file, that is links to pages and records, and links to files.
  • Under mail you set the sender name, sender address, reply-to address and subject of the report email.

Why no external links? External checks depend on other servers. They can hang, time out or give false results, for example when a server rejects check requests. The documentation lists this under known problems. To check external links, you add external to linktypes and adjust the time limits under linktypesConfig.

mod.linkvalidator {
  linktypes = db,file,external
  linktypesConfig.external.timeout = 10
  mail.fromemail = web@musikschule-lindenau.example
}
Page TSconfig example. The link types are extended with external, the time limit for external requests is 10 seconds, and the sender address of the reports is set.

Checking regularly: Mara creates a scheduler task of the type LinkValidator, with a start page, a depth and an email address. When there are broken links, the task sends a report. The mail template can be replaced as well.

The link validator checks content in the database, not links in PHP files or templates. And it only runs in the backend module or through the scheduler, never when a page is requested in the frontend.

Recycler, reports and status

Recycler: A teacher has accidentally deleted the page “Recorder”. TYPO3 usually does not really delete records, but sets the field deleted to 1. This is called a soft delete. The module Content > Recycler shows exactly these records, from all tables, not just files. There you restore them or delete them permanently. When you restore a page, you can bring back its content and subpages recursively. How deep the search reaches from the selected page is set with the depth. What has been deleted permanently cannot be brought back, not even by the recycler.

By default, editors may only restore in the recycler. You allow them to delete permanently with mod.recycler.allowDelete in User TSconfig.

So that deleted records do not pile up forever, the recycler brings the scheduler task Remove deleted records. It permanently removes records marked as deleted from selected tables once they are older than the configured number of days, for example 30. This does not happen on its own.

Reports: The module Administration > Reports holds diagnostic data about the installation. Its most important part is the Status Report. It collects checks from the core and from extensions, grouped by area.

  • Security, for example whether the Install Tool is protected, whether the connection is encrypted, whether trustedHostsPattern is set sensibly, or whether export files are lying around.
  • System and configuration, for example the PHP environment, file permissions and the database.
  • Notes from extensions, which can add their own checks, for example about redirects.

Reports also shows Record Statistics and, since TYPO3 14, Content statistics. Visitor numbers, search terms or sales figures are not part of it.

The scheduler task System Status Update checks the status regularly and mails one or more addresses. By default it only sends a mail when there are warnings or errors, but it can send one every time.

Status: Not to be confused with Content > Status, which was called Info up to TYPO3 13. It shows information about the pages in the selected part of the page tree. Examples are the Pagetree Overview and the Localization Overview, which shows which pages are translated. Extensions can add their own views.

The scheduler and the cron job

The scheduler is the module for planned tasks, under Administration > Scheduler. A task runs once at a fixed time or repeatedly. Typical tasks are cleaning up, indexing and reports.

But the scheduler does not start by itself. It needs a cron job on the server that regularly calls the command scheduler:run. Only then does the scheduler check which tasks are due and run them. Neither a logged-in admin nor a website visitor triggers tasks.

Server cron job, every 15 minutes */15 * * * * php vendor/bin/typo3 scheduler:run Scheduler looks for due tasks Administration > Scheduler Link check LinkValidator Workspace auto-publish Status update System Status Deleted records cleanup Without a cron job, everything stays “never run”.
Without a cron job, no task starts.

Mara adds a line to the server's crontab that calls the scheduler every 15 minutes:

*/15 * * * * php /var/www/lindenau/vendor/bin/typo3 scheduler:run
Crontab line. Star slash 15 in the minute field, then four stars, then calling vendor bin typo3 scheduler run with PHP.

Star slash 15 in the minute field means every 15 minutes. A plain 15 in the minute field would run once an hour, at minute 15. A 0 in the minute field with star slash 15 in the hour field would only run every 15 hours.

There are three scheduler commands on the command line:

  • scheduler:run runs all due tasks. This is what the cron job calls.
  • scheduler:list shows all tasks with their status.
  • scheduler:execute starts specific tasks immediately, whether they are due or not.

Tasks from the core: The scheduler itself brings these tasks, among others:

  • Table garbage collection deletes old entries from tables such as sys_log.
  • IP anonymization shortens IP addresses in tables such as sys_log.
  • Execute console commands runs any TYPO3 command on a schedule.
  • There are also Caching framework garbage collection, Fileadmin garbage collection, Optimize MySQL database tables and two tasks for file storages.

Other system extensions add more tasks, for example the link validator, the recycler and Reports. Automatic translation or newsletter dispatch are not part of the core.

Reactions and webhooks

There are two ways to exchange data with other systems, running in opposite directions. You manage both in the module Administration > Integrations, which only admins can see.

Reaction incoming Ticket system sends JSON header x-api-key TYPO3 creates a record Webhook outgoing TYPO3 page changed header Webhook- Signature Newsletter service checks signature Both under Administration > Integrations
A reaction is incoming, a webhook is outgoing.

Reactions receive incoming webhooks. They come with the system extension reactions. An external service calls a TYPO3 URL, and TYPO3 reacts. The core ships exactly one reaction type: Create database record, which creates a record. Developers can add more types through the ReactionInterface.

At the music school, the ticket system sends every new concert date to TYPO3. Mara creates a reaction for it and chooses the table, the folder and the fields. Placeholders in the field values take values from the data sent. Impersonate User is important: the reaction creates records in the name of this backend user, so that user's permissions decide what it may do. When in doubt, the documentation recommends the CLI user _cli_.

When you create the reaction, TYPO3 generates a secret. The caller sends it with every request in the header x-api-key, because reactions are not public. TYPO3 only stores a hash of it, so Mara copies it right away.

Mara gives the developer of the ticket system three things: the URL of the reaction, the secret and the expected structure of the JSON data. He does not need database credentials or the Install Tool password.

POST https://www.musikschule-lindenau.example/typo3/reaction/<identifier>
x-api-key: <secret>
Content-Type: application/json

{"title": "Summer concert", "date": "2027-06-20"}

Field value in the reaction:  ${title}
Example of a request to a reaction. A POST to the path typo3 reaction with the identifier of the reaction, the secret in the header x-api-key, and JSON data with a title and a date. Below it a field value with the placeholder title.

Webhooks go the other way and come with the system extension webhooks. A webhook is an automatic HTTP message: when an event happens, TYPO3 sends a request to a configured URL. That way other systems learn about it in real time. The core offers these triggers:

  • A page is created or changed, called Page Modification in the backend.
  • A file is added, updated or removed.
  • A login fails.
  • Multi-factor authentication fails.

The redirects extension adds a trigger for redirects that are hit. Developers can add more triggers through PSR-14 events.

GET or POST: On the webhook you choose the HTTP method. POST is the usual choice: the event data is sent as JSON in the body, and the receiver reads it from there. TYPO3 attaches the body with GET too, but in HTTP a body has no defined meaning for GET, and many receivers ignore it. The signature works the same way with both methods.

The secret of a webhook lets the receiver check the origin. TYPO3 uses the PHP function hash_hmac with SHA-256 to build a hash from the webhook's identifier and the JSON content, with the secret as the key. TYPO3 sends this hash in the header Webhook-Signature. The receiver recalculates it with the secret and compares. If it matches, the message really comes from TYPO3 and was not changed on the way.

The reference index

TYPO3 records in the table sys_refindex which records and files point to each other. That is the reference index. The backend uses it, for example, to warn that an image is still in use when someone wants to delete it.

Changes through the DataHandler, that is everything editors save in the backend, keep the index up to date automatically. If you change data directly with SQL, for example by importing a database dump, the index gets out of sync, and you have to update it. The documentation also explicitly recommends updating it before an upgrade.

You update it on the command line with referenceindex:update. With the option check, the command only checks and changes nothing. In the backend, the module System > Maintenance has the card “Check and Update Reference Index”.

vendor/bin/typo3 referenceindex:update --check
vendor/bin/typo3 referenceindex:update
Two commands. The first only checks the reference index, the second rebuilds it.

On large installations, rebuilding takes a long time, and in the backend it stops with a timeout. The command line has no time limit like a web request. That makes it the right tool, especially before upgrades.

The command line

Many tasks on this page also work on the command line, the Command Line Interface or CLI. In a Composer project, the script vendor/bin/typo3 runs the TYPO3 commands. In a classic installation without Composer, the script typo3 lives in the bin folder of the system extension core. If the file is not executable, you call it with PHP in front.

The command line runs wherever PHP and the project are available. Mara uses it locally in DDEV with ddev exec, on the server through SSH and in the deployment pipeline, without the backend or the Install Tool.

Finding commands: The command list shows all commands with a short description, grouped by namespace, such as cache, scheduler or referenceindex. Calling the script without an argument shows the same list. For help on a command, use help followed by the command name, or the command with the option help, h for short. The help lists the description, arguments and options.

vendor/bin/typo3 list
vendor/bin/typo3 help cache:flush
vendor/bin/typo3 cache:flush --help
Commands. List all commands, then twice the help for the command cache flush, once with help in front and once with the option help after it.

Arguments and options: The TYPO3 command line is built on Symfony Console. Arguments follow without dashes in a fixed order. Options start with two dashes, and you attach a value with an equals sign. Many options also have a short form with one dash.

vendor/bin/typo3 cache:flush --group=pages
vendor/bin/typo3 scheduler:run --no-interaction -vv
Examples of options. An option with a value, joined by an equals sign. Below it the scheduler call with no-interaction and very verbose output.

Some options apply to all commands:

  • The options v, vv and vvv with one dash increase the verbosity of the output step by step.
  • The option q makes the output quiet.
  • The option n, long form no-interaction, suppresses questions. You need it in a cron job, because nobody is there to answer.
  • The option help shows the help for the command.

Options come after the command name, not before the script. Each command defines how many arguments it needs, and many need none.

Key points

  • Workspaces from the system extension workspaces keep changes separate from LIVE until they are published. Only users with explicit permission may then work live.
  • Owners may do everything, members edit. Admins have access to all workspaces.
  • The default stages are Editing and Ready to publish. Custom stages sit in between.
  • A publishing date only works with the scheduler task and a cron job, and it only publishes what has reached Ready to publish.
  • Preview links are valid for 48 hours by default, and since TYPO3 14.2 for all record types.
  • Import and export work with XML or T3D and are admin-only by default. Export files in fileadmin are public and should be deleted.
  • Since TYPO3 13, the link validator checks only db and file by default, and through the scheduler it also sends a mail report.
  • The recycler only shows soft deletes. Permanent deletion is allowed with mod.recycler.allowDelete.
  • The scheduler needs a cron job that calls scheduler:run.
  • Reactions are incoming, webhooks outgoing, both under Administration > Integrations.
  • The reference index is updated with referenceindex:update, best on the command line.

Terms

Cron job
Scheduled entry on the server that starts a command regularly.
HMAC
Method that builds a check value from content and a secret key.
LIVE workspace
Normal working environment whose changes are visible immediately.
Mount point
Entry point in the page tree to which a user or workspace is restricted.
Reaction
Incoming webhook to which TYPO3 responds, for example with a new record.
Reference index
Table sys_refindex with all references between records and files.
Soft delete
Deleting by marking the field deleted, while the record stays in the database.
Stage
Step in the review process of a workspace.
T3D
TYPO3's own export format for page trees and records.
Webhook
Automatic HTTP message that TYPO3 sends to a URL when an event happens.

As of: November 16, 2026 (TYPO3 14.3 LTS)

Sources:

  • TYPO3 Workspaces 14.3 (typo3/cms-workspaces), chapters Users Guide, Creating a custom workspace, Scheduler tasks
  • Documentation of the system extensions impexp, linkvalidator, recycler, reports, scheduler, reactions and webhooks 14.3
  • TYPO3 Explained 14.3, chapters Console commands (CLI) and Update Reference Index
  • Changelog TYPO3 14.2, Feature 108831 (preview links for all records)
  • Source code TYPO3 14.3.10, checked for module names, workspace fields, LIVE permissions, impexp permissions, status report, scheduler tasks, reaction secret and webhook sending
  • Learning objectives TYPO3 CMS Certified Integrator 14 LTS, area Backend Modules and Automation

This study guide was written with AI and checked against the sources.

Certifications & exams

Which exam comes next?

You can already practise for 51 exams, and 16 are up for a vote. See all certifications with their official information, cast your vote or suggest your exam.

See all certifications