Chapter 14
Integrations
User and privacy plugins and the REST API.
Semantyca connects to Joomla user accounts, Joomla's privacy tools and external systems through the plugins installed with the package.
User - Semantyca
The plugin keeps subscribers in sync with Joomla accounts: a linked subscriber follows changes of the account's e-mail address and name, and an existing subscriber is linked to a new account with the same, verified address. Configure it under System → Manage → Plugins, search for User - Semantyca.
| Option | Description |
|---|---|
| Offer on registration | Adds a newsletter checkbox (Yes, send me the newsletter) to Joomla's registration form. |
| Subscribe to | Lists that new users who tick the box join. |
| Pre-ticked | Pre-ticks the checkbox. Pre-ticked boxes are not valid consent under the GDPR; leave off unless you are sure. |
| When a user is deleted | Keep the subscriber (default, only the link is removed), Unsubscribe them or Delete their newsletter data. |
To make every member of a Joomla group a recipient without asking them to sign up, use Include user groups on the list instead. See Lists.
Privacy - Semantyca
With Joomla's Privacy component enabled, this plugin includes Semantyca data (subscriber details, lists, newsletters received and consent records) in privacy exports and removes it when a removal request is completed. Requests are handled under Users → Privacy → Requests; the Privacy requests button on Semantyca's Privacy and consent screen leads there.
REST API
The Web Services - Semantyca plugin adds REST routes to Joomla's API. Authenticate with a Joomla API token (Users → Manage → [user] → Joomla API Token); the user's permissions apply.
| Method and route | Purpose |
|---|---|
GET /api/index.php/v1/semantyca/subscribers | List subscribers |
POST /api/index.php/v1/semantyca/subscribers | Create a subscriber |
GET, PATCH, DELETE /api/index.php/v1/semantyca/subscribers/:id | Read, update or delete a subscriber |
GET, POST /api/index.php/v1/semantyca/lists; GET, PATCH, DELETE …/lists/:id | Manage lists |
GET /api/index.php/v1/semantyca/newsletters[/:id] | Read newsletters with their statistics (read-only) |
Example request body for a new subscriber:
{"email": "laura.weber@example.com", "name": "Laura Weber", "status": "subscribed", "lists": [1]}
Subscribers created through the API get the source API.
subscribed through the API when you can prove their consent, for example because your own sign-up process already confirmed their address.Last updated 16 November 2026