# Joomla

> Run your Joomla website from workflows: publish, schedule and update articles with their images, find and read articles, manage categories, and add site users. Start a workflow when an article is added or changed.

App · 12 actions. Web page: https://docs.lodol.com/docs/integrations/joomla

## Actions

### Create article

Publish an article on the site, such as news from a form, a document or an AI step, in a category with tags, now or at a time you choose.

**Inputs**

- Title (`title`, text, required): The article's title.
- Text (`content`, text, required): What the article says, in the format chosen.
- Format (`content_format`, text): How the text and intro are written. Choose Markdown for what an AI step writes. Defaults to HTML. One of: `html`, `markdown`, `plain_text` (Plain text). Default: `html`.
- Intro text (`intro_text`, text): A short opening, shown in lists of articles with a Read more link to the text. Leave blank for none.
- Category (`category`, text, required): The category to put it in.
- Tags (`tags`, list): Tags to put on it. A name the site doesn't have yet is added as a new tag.
- Status (`status`, text): Whether it shows on the site. Defaults to published. One of: `published`, `unpublished`. Default: `published`.
- Featured (`featured`, text): Whether to feature it, such as on the home page. Defaults to no. One of: `yes`, `no`. Default: `no`.
- Start publishing (`publish_up`, date and time): When it starts showing on the site. Set a time ahead to schedule it.
- Finish publishing (`publish_down`, date and time): When it stops showing on the site. Leave blank to keep showing it.
- Language (`language`, text): The language it's in, for a site in several languages. Defaults to all languages.
- Access (`access`, text): Who can see it, such as Public or Registered. Defaults to the site's setting, usually Public.
- Alias (`alias`, text): The part of its web address made from the title, such as spring-volunteer-day. Joomla makes one from the title if blank.
- Meta description (`meta_description`, text): A sentence or two for search engines to show.
- Image (`image`, text): A picture to show with it: the path from 'Upload image', such as images/news/photo.jpg, or a web address.
- Image description (`image_alt`, text): What the picture shows, for people who can't see it.
- Author's alias (`author_alias`, text): A name to show as its author instead of yours, such as the person who sent it in.

**Outputs**

- `access_level` (text): Who can see it, such as Public or Registered
- `alias` (text): Its URL alias, the part of its web address made from the title
- `author` (text): The name of the user who wrote it
- `author_alias` (text): The name shown as its author instead, if one was given
- `author_id` (number): The ID of the user who wrote it
- `category` (text): The name of the category it's in
- `category_id` (number): The ID of the category it's in
- `created_at` (text): When it was added (ISO 8601, UTC)
- `edit_link` (text): Where an administrator edits it in Joomla
- `featured` (true/false): Whether it's featured
- `hits` (number): How many times it has been viewed
- `id` (number): The article's ID
- `image` (text): The web address of its intro image; empty if it has none
- `language` (text): Its language code, such as en-GB, or * for all languages
- `link` (text): Its address on the website
- `meta_description` (text): Its meta description, for search engines
- `publish_down` (text): When it stops showing; empty if never (ISO 8601, UTC)
- `publish_up` (text): When it starts showing on the site (ISO 8601, UTC)
- `status` (text): published, unpublished, archived or trashed
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `title` (text): The article's title
- `updated_at` (text): When it last changed (ISO 8601, UTC)

**Example output**

```json
{
  "access_level": "Public",
  "alias": "spring-volunteer-day",
  "author": "Site Admin",
  "author_alias": "",
  "author_id": 401,
  "category": "News",
  "category_id": 8,
  "created_at": "2026-11-05T08:55:00Z",
  "edit_link": "https://www.example.org/administrator/index.php?option=com_content&task=article.edit&id=42",
  "featured": false,
  "hits": 12,
  "id": 42,
  "image": "https://www.example.org/images/news/volunteers.jpg",
  "language": "*",
  "link": "https://www.example.org/index.php?option=com_content&view=article&id=42&catid=8",
  "meta_description": "Join us for a day in the park.",
  "publish_down": "",
  "publish_up": "2026-11-05T09:00:00Z",
  "status": "published",
  "tag_ids": [
    2
  ],
  "tags": [
    "Volunteers"
  ],
  "title": "Spring volunteer day",
  "updated_at": "2026-11-05T09:10:00Z"
}
```

### Create category

Add an article category, at the top or inside another, such as for a new event or project.

**Inputs**

- Name (`title`, text, required): What the category is called.
- Inside (`parent`, text): The category to put it in. Leave blank to put it at the top.
- Description (`description`, text): What it's about, as HTML, shown on its page.
- Status (`status`, text): Whether it shows on the site. Defaults to published. One of: `published`, `unpublished`. Default: `published`.
- Language (`language`, text): The language it's in, for a site in several languages. Defaults to all languages.
- Access (`access`, text): Who can see it, such as Public or Registered. Defaults to the site's setting, usually Public.
- Alias (`alias`, text): The part of its web address made from the name. Joomla makes one if blank.

**Outputs**

- `access_level` (text): Who can see it, such as Public
- `alias` (text): Its URL alias
- `description` (text): Its description, as HTML
- `id` (number): The category's ID
- `language` (text): Its language code, or * for all languages
- `level` (number): How deep it is: 1 at the top
- `link` (text): Its page on the website
- `parent_id` (number): The ID of the category it's in; 1 if it's at the top
- `path` (text): Its name after the names of the categories it's in, such as News > Local
- `published_articles` (number): How many published articles it holds
- `status` (text): published, unpublished, archived or trashed
- `title` (text): The category's name

**Example output**

```json
{
  "access_level": "Public",
  "alias": "news",
  "description": "",
  "id": 8,
  "language": "*",
  "level": 1,
  "link": "https://www.example.org/index.php?option=com_content&view=category&id=8",
  "parent_id": 1,
  "path": "News",
  "published_articles": 14,
  "status": "published",
  "title": "News"
}
```

### Create user

Add a user to the site, such as a member who signed up. Joomla emails them their username and password, unless the site turned that off.

**Inputs**

- Name (`name`, text, required): The person's name.
- Email (`email`, text, required): Their email address.
- Username (`username`, text): What they sign in with. Defaults to their email address.
- Password (`password`, text): Their password. Leave blank for Joomla to make one and email it to them.
- User groups (`groups`, list): The groups to put them in, which decide what they can do. Defaults to Registered.
- Blocked (`blocked`, true/false): Add them blocked, so they can't sign in until unblocked. Default: `false`.

**Outputs**

- `blocked` (true/false): Whether they're blocked from signing in
- `email` (text): Their email address
- `groups` (list): The names of the user groups they're in
- `id` (number): The user's ID
- `last_visit_at` (text): When they last signed in; empty if never (ISO 8601, UTC)
- `name` (text): Their name
- `registered_at` (text): When they were added (ISO 8601, UTC)
- `username` (text): What they sign in with

**Example output**

```json
{
  "blocked": false,
  "email": "ada@example.com",
  "groups": [
    "Registered"
  ],
  "id": 402,
  "last_visit_at": "",
  "name": "Ada Lovelace",
  "registered_at": "2026-11-05T09:00:00Z",
  "username": "ada"
}
```

### Delete article

Move an article to the trash, where an administrator can restore it, or delete it for good.

**Inputs**

- Article (`article`, text, required): The article's ID (a number, such as 42) from another Joomla step or the trigger, or its link on the site.
- Delete for good (`permanently`, true/false): Delete it for good instead of moving it to the trash, where an administrator can restore it. Default: `false`.

**Outputs**

- `deleted` (true/false): Whether it was trashed or deleted
- `id` (number): The article's ID
- `permanently` (true/false): Whether it was deleted for good rather than trashed
- `title` (text): The article's title

**Example output**

```json
{
  "deleted": true,
  "id": 42,
  "permanently": false,
  "title": "Spring volunteer day"
}
```

### Delete category

Move a category to the trash, or delete it for good. Joomla only deletes a category that holds no articles or categories.

**Inputs**

- Category (`category`, text, required): The category to delete.
- Delete for good (`permanently`, true/false): Delete it for good instead of moving it to the trash, where an administrator can restore it. Default: `false`.

**Outputs**

- `deleted` (true/false): Whether it was trashed or deleted
- `id` (number): The category's ID
- `permanently` (true/false): Whether it was deleted for good rather than trashed
- `title` (text): The category's name

**Example output**

```json
{
  "deleted": true,
  "id": 12,
  "permanently": true,
  "title": "Old news"
}
```

### Delete user

Delete a user from the site for good, such as a member who left. Their articles stay.

**Inputs**

- User (`user`, text, required): The user: their ID from another Joomla step, username or email address.

**Outputs**

- `deleted` (true/false): Whether the user was deleted
- `email` (text): Their email address
- `id` (number): The user's ID
- `name` (text): Their name
- `username` (text): Their username

**Example output**

```json
{
  "deleted": true,
  "email": "ada@example.com",
  "id": 402,
  "name": "Ada Lovelace",
  "username": "ada"
}
```

### Find articles

Find articles by category, status, words in the title, author, tag or when they changed, newest first.

**Inputs**

- Category (`category`, text): Only articles in this category or the ones inside it.
- Status (`status`, text): Only articles with this status. Leave blank for published and unpublished ones. One of: `published`, `unpublished`, `archived`, `trashed`.
- Search (`search`, text): Words in the title or alias. Start with content: to look in the text instead, such as content:volunteers.
- Author (`author`, text): Only articles by this user: their ID, username or email.
- Tag (`tag`, text): Only articles with this tag.
- Featured (`featured`, text): Only featured articles, or only ones that aren't. One of: `yes`, `no`.
- Language (`language`, text): Only articles in this language.
- Changed since (`changed_since`, date and time): Only articles added or changed after this time.
- Order (`sort`, text): Which come first. Defaults to newest first. One of: `created` (Newest first), `modified` (Recently changed first), `publish_up` (Latest publish date first), `title`, `hits` (Most viewed first). Default: `created`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `articles` (list): The articles found
- `count` (number): How many are listed
- `has_more` (true/false): Whether there are more than were listed

**Example output**

```json
{
  "articles": [
    {
      "access_level": "Public",
      "alias": "spring-volunteer-day",
      "author": "Site Admin",
      "author_alias": "",
      "author_id": 401,
      "category": "News",
      "category_id": 8,
      "created_at": "2026-11-05T08:55:00Z",
      "edit_link": "https://www.example.org/administrator/index.php?option=com_content&task=article.edit&id=42",
      "featured": false,
      "hits": 12,
      "id": 42,
      "image": "https://www.example.org/images/news/volunteers.jpg",
      "language": "*",
      "link": "https://www.example.org/index.php?option=com_content&view=article&id=42&catid=8",
      "meta_description": "Join us for a day in the park.",
      "publish_down": "",
      "publish_up": "2026-11-05T09:00:00Z",
      "status": "published",
      "tag_ids": [
        2
      ],
      "tags": [
        "Volunteers"
      ],
      "title": "Spring volunteer day",
      "updated_at": "2026-11-05T09:10:00Z"
    }
  ],
  "count": 1,
  "has_more": false
}
```

### Find users

Find the site's users by name, username or email, group, status or when they joined, newest first.

**Inputs**

- Search (`search`, text): Words in their name, username or email address.
- User group (`group`, text): Only users in this group.
- Status (`status`, text): Only active users, or only blocked ones. One of: `active`, `blocked`.
- Joined since (`registered_since`, date and time): Only users added after this time.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `has_more` (true/false): Whether there are more than were listed
- `users` (list): The users found

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "users": [
    {
      "blocked": false,
      "email": "ada@example.com",
      "groups": [
        "Registered"
      ],
      "id": 402,
      "last_visit_at": "",
      "name": "Ada Lovelace",
      "registered_at": "2026-11-05T09:00:00Z",
      "username": "ada"
    }
  ]
}
```

### Get article

Get an article's details and its text, as HTML and as plain text, such as for an AI step or an email.

**Inputs**

- Article (`article`, text, required): The article's ID (a number, such as 42) from another Joomla step or the trigger, or its link on the site.

**Outputs**

- `access_level` (text): Who can see it, such as Public or Registered
- `alias` (text): Its URL alias, the part of its web address made from the title
- `author` (text): The name of the user who wrote it
- `author_alias` (text): The name shown as its author instead, if one was given
- `author_id` (number): The ID of the user who wrote it
- `category` (text): The name of the category it's in
- `category_id` (number): The ID of the category it's in
- `content` (text): The whole article as HTML, its intro text first
- `created_at` (text): When it was added (ISO 8601, UTC)
- `edit_link` (text): Where an administrator edits it in Joomla
- `featured` (true/false): Whether it's featured
- `full_text` (text): The text after the intro, as HTML; all of it if there is no intro
- `hits` (number): How many times it has been viewed
- `id` (number): The article's ID
- `image` (text): The web address of its intro image; empty if it has none
- `intro_text` (text): The intro, before the Read more break, as HTML; empty if it has none
- `language` (text): Its language code, such as en-GB, or * for all languages
- `link` (text): Its address on the website
- `meta_description` (text): Its meta description, for search engines
- `publish_down` (text): When it stops showing; empty if never (ISO 8601, UTC)
- `publish_up` (text): When it starts showing on the site (ISO 8601, UTC)
- `status` (text): published, unpublished, archived or trashed
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `text` (text): The whole article as plain text, without HTML
- `title` (text): The article's title
- `updated_at` (text): When it last changed (ISO 8601, UTC)

**Example output**

```json
{
  "access_level": "Public",
  "alias": "spring-volunteer-day",
  "author": "Site Admin",
  "author_alias": "",
  "author_id": 401,
  "category": "News",
  "category_id": 8,
  "content": "<p>Join us on the 12th.</p>",
  "created_at": "2026-11-05T08:55:00Z",
  "edit_link": "https://www.example.org/administrator/index.php?option=com_content&task=article.edit&id=42",
  "featured": false,
  "full_text": "",
  "hits": 12,
  "id": 42,
  "image": "https://www.example.org/images/news/volunteers.jpg",
  "intro_text": "<p>Join us on the 12th.</p>",
  "language": "*",
  "link": "https://www.example.org/index.php?option=com_content&view=article&id=42&catid=8",
  "meta_description": "Join us for a day in the park.",
  "publish_down": "",
  "publish_up": "2026-11-05T09:00:00Z",
  "status": "published",
  "tag_ids": [
    2
  ],
  "tags": [
    "Volunteers"
  ],
  "text": "Join us on the 12th.",
  "title": "Spring volunteer day",
  "updated_at": "2026-11-05T09:10:00Z"
}
```

### List categories

List the site's article categories, with how many published articles each holds.

**Inputs**

- Search (`search`, text): Words in the category's name.
- Status (`status`, text): Only categories with this status. Leave blank for published and unpublished ones. One of: `published`, `unpublished`, `archived`, `trashed`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `categories` (list): The categories
- `count` (number): How many are listed
- `has_more` (true/false): Whether there are more than were listed

**Example output**

```json
{
  "categories": [
    {
      "access_level": "Public",
      "alias": "news",
      "description": "",
      "id": 8,
      "language": "*",
      "level": 1,
      "link": "https://www.example.org/index.php?option=com_content&view=category&id=8",
      "parent_id": 1,
      "path": "News",
      "published_articles": 14,
      "status": "published",
      "title": "News"
    }
  ],
  "count": 1,
  "has_more": false
}
```

### Update article

Change an article's title, text, category, tags, status, dates or other details, such as to unpublish or archive it. Fields left blank keep what the article has.

**Inputs**

- Article (`article`, text, required): The article's ID (a number, such as 42) from another Joomla step or the trigger, or its link on the site.
- Title (`title`, text): A new title. Leave blank to keep it.
- Text (`content`, text): What the article says, in the format chosen. Leave blank to keep it.
- Format (`content_format`, text): How the text and intro are written. Choose Markdown for what an AI step writes. Defaults to HTML. One of: `html`, `markdown`, `plain_text` (Plain text). Default: `html`.
- Intro text (`intro_text`, text): A short opening, shown in lists of articles with a Read more link to the text. Leave blank to keep it.
- Category (`category`, text): A category to move it to. Leave blank to keep it.
- Tags (`tags`, list): Tags to put on it instead of the ones it has. Leave blank to keep them.
- Status (`status`, text): Publish, unpublish or archive it. Leave blank to keep it. One of: `published`, `unpublished`, `archived`.
- Featured (`featured`, text): Whether to feature it. Leave blank to keep it. One of: `yes`, `no`.
- Start publishing (`publish_up`, date and time): When it starts showing on the site. Set a time ahead to schedule it.
- Finish publishing (`publish_down`, date and time): When it stops showing on the site. Leave blank to keep showing it.
- Language (`language`, text): The language it's in, for a site in several languages. Defaults to all languages.
- Access (`access`, text): Who can see it, such as Public or Registered. Defaults to the site's setting, usually Public.
- Alias (`alias`, text): The part of its web address made from the title, such as spring-volunteer-day. Joomla makes one from the title if blank.
- Meta description (`meta_description`, text): A sentence or two for search engines to show.
- Image (`image`, text): A picture to show with it: the path from 'Upload image', such as images/news/photo.jpg, or a web address.
- Image description (`image_alt`, text): What the picture shows, for people who can't see it.

**Outputs**

- `access_level` (text): Who can see it, such as Public or Registered
- `alias` (text): Its URL alias, the part of its web address made from the title
- `author` (text): The name of the user who wrote it
- `author_alias` (text): The name shown as its author instead, if one was given
- `author_id` (number): The ID of the user who wrote it
- `category` (text): The name of the category it's in
- `category_id` (number): The ID of the category it's in
- `created_at` (text): When it was added (ISO 8601, UTC)
- `edit_link` (text): Where an administrator edits it in Joomla
- `featured` (true/false): Whether it's featured
- `hits` (number): How many times it has been viewed
- `id` (number): The article's ID
- `image` (text): The web address of its intro image; empty if it has none
- `language` (text): Its language code, such as en-GB, or * for all languages
- `link` (text): Its address on the website
- `meta_description` (text): Its meta description, for search engines
- `publish_down` (text): When it stops showing; empty if never (ISO 8601, UTC)
- `publish_up` (text): When it starts showing on the site (ISO 8601, UTC)
- `status` (text): published, unpublished, archived or trashed
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `title` (text): The article's title
- `updated_at` (text): When it last changed (ISO 8601, UTC)

**Example output**

```json
{
  "access_level": "Public",
  "alias": "spring-volunteer-day",
  "author": "Site Admin",
  "author_alias": "",
  "author_id": 401,
  "category": "News",
  "category_id": 8,
  "created_at": "2026-11-05T08:55:00Z",
  "edit_link": "https://www.example.org/administrator/index.php?option=com_content&task=article.edit&id=42",
  "featured": false,
  "hits": 12,
  "id": 42,
  "image": "https://www.example.org/images/news/volunteers.jpg",
  "language": "*",
  "link": "https://www.example.org/index.php?option=com_content&view=article&id=42&catid=8",
  "meta_description": "Join us for a day in the park.",
  "publish_down": "",
  "publish_up": "2026-11-05T09:00:00Z",
  "status": "published",
  "tag_ids": [
    2
  ],
  "tags": [
    "Volunteers"
  ],
  "title": "Spring volunteer day",
  "updated_at": "2026-11-05T09:10:00Z"
}
```

### Upload image

Put an image in the site's images folder, to show in an article: give the path it returns to an article's Image field, or use its link in the text.

**Inputs**

- Image (`file`, text, required): The image: upload one, pick one from an earlier step, or give a public https link to one. JPG, PNG, GIF, WebP, AVIF, BMP or SVG.
- Folder (`folder`, text): A folder inside images to put it in, such as news/2026. It's made if it isn't there. Leave blank for images itself.
- File name (`file_name`, text): What to call it, such as volunteers.jpg. Defaults to the file's own name.
- If the name is taken (`if_exists`, text): What to do when the folder already has a file of that name. Defaults to keeping both. One of: `rename` (Keep both (number the new one)), `replace` (Replace it). Default: `rename`.

**Outputs**

- `content_type` (text): Its type, such as image/jpeg
- `folder` (text): The folder it's in, inside images; empty for images itself
- `height` (number): Its height in pixels
- `name` (text): The file's name
- `path` (text): Where it is on the site, such as images/news/photo.jpg: give this to an article's Image field
- `size` (number): Its size in bytes
- `url` (text): Its web address
- `width` (number): Its width in pixels

**Example output**

```json
{
  "content_type": "image/jpeg",
  "folder": "news",
  "height": 800,
  "name": "volunteers.jpg",
  "path": "images/news/volunteers.jpg",
  "size": 48213,
  "url": "https://www.example.org/images/news/volunteers.jpg",
  "width": 1200
}
```
