Joomla

App · 12 actions

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.

Actions

ActionWhat it does
Create articlePublish 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.
Create categoryAdd an article category, at the top or inside another, such as for a new event or project.
Create userAdd a user to the site, such as a member who signed up.
Delete articleMove an article to the trash, where an administrator can restore it, or delete it for good.
Delete categoryMove a category to the trash, or delete it for good.
Delete userDelete a user from the site for good, such as a member who left.
Find articlesFind articles by category, status, words in the title, author, tag or when they changed, newest first.
Find usersFind the site's users by name, username or email, group, status or when they joined, newest first.
Get articleGet an article's details and its text, as HTML and as plain text, such as for an AI step or an email.
List categoriesList the site's article categories, with how many published articles each holds.
Update articleChange an article's title, text, category, tags, status, dates or other details, such as to unpublish or archive it.
Upload imagePut 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.

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

TitletitletextRequired
The article's title.
TextcontenttextRequired
What the article says, in the format chosen.
Formatcontent_formattext
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 textintro_texttext
A short opening, shown in lists of articles with a Read more link to the text. Leave blank for none.
CategorycategorytextRequired
The category to put it in.
Tagstagslist
Tags to put on it. A name the site doesn't have yet is added as a new tag.
Statusstatustext
Whether it shows on the site. Defaults to published.One of: published, unpublished. Default: published.
Featuredfeaturedtext
Whether to feature it, such as on the home page. Defaults to no.One of: yes, no. Default: no.
Start publishingpublish_update and time
When it starts showing on the site. Set a time ahead to schedule it.
Finish publishingpublish_downdate and time
When it stops showing on the site. Leave blank to keep showing it.
Languagelanguagetext
The language it's in, for a site in several languages. Defaults to all languages.
Accessaccesstext
Who can see it, such as Public or Registered. Defaults to the site's setting, usually Public.
Aliasaliastext
The part of its web address made from the title, such as spring-volunteer-day. Joomla makes one from the title if blank.
Meta descriptionmeta_descriptiontext
A sentence or two for search engines to show.
Imageimagetext
A picture to show with it: the path from 'Upload image', such as images/news/photo.jpg, or a web address.
Image descriptionimage_alttext
What the picture shows, for people who can't see it.
Author's aliasauthor_aliastext
A name to show as its author instead of yours, such as the person who sent it in.

Outputs

access_leveltext
Who can see it, such as Public or Registered
aliastext
Its URL alias, the part of its web address made from the title
authortext
The name of the user who wrote it
author_aliastext
The name shown as its author instead, if one was given
author_idnumber
The ID of the user who wrote it
categorytext
The name of the category it's in
category_idnumber
The ID of the category it's in
created_attext
When it was added (ISO 8601, UTC)
edit_linktext
Where an administrator edits it in Joomla
featuredtrue/false
Whether it's featured
hitsnumber
How many times it has been viewed
idnumber
The article's ID
imagetext
The web address of its intro image; empty if it has none
languagetext
Its language code, such as en-GB, or * for all languages
linktext
Its address on the website
meta_descriptiontext
Its meta description, for search engines
publish_downtext
When it stops showing; empty if never (ISO 8601, UTC)
publish_uptext
When it starts showing on the site (ISO 8601, UTC)
statustext
published, unpublished, archived or trashed
tag_idslist
The IDs of its tags
tagslist
The names of its tags
titletext
The article's title
updated_attext
When it last changed (ISO 8601, UTC)
Example output
{
  "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

NametitletextRequired
What the category is called.
Insideparenttext
The category to put it in. Leave blank to put it at the top.
Descriptiondescriptiontext
What it's about, as HTML, shown on its page.
Statusstatustext
Whether it shows on the site. Defaults to published.One of: published, unpublished. Default: published.
Languagelanguagetext
The language it's in, for a site in several languages. Defaults to all languages.
Accessaccesstext
Who can see it, such as Public or Registered. Defaults to the site's setting, usually Public.
Aliasaliastext
The part of its web address made from the name. Joomla makes one if blank.

Outputs

access_leveltext
Who can see it, such as Public
aliastext
Its URL alias
descriptiontext
Its description, as HTML
idnumber
The category's ID
languagetext
Its language code, or * for all languages
levelnumber
How deep it is: 1 at the top
linktext
Its page on the website
parent_idnumber
The ID of the category it's in; 1 if it's at the top
pathtext
Its name after the names of the categories it's in, such as News > Local
published_articlesnumber
How many published articles it holds
statustext
published, unpublished, archived or trashed
titletext
The category's name
Example output
{
  "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

NamenametextRequired
The person's name.
EmailemailtextRequired
Their email address.
Usernameusernametext
What they sign in with. Defaults to their email address.
Passwordpasswordtext
Their password. Leave blank for Joomla to make one and email it to them.
User groupsgroupslist
The groups to put them in, which decide what they can do. Defaults to Registered.
Blockedblockedtrue/false
Add them blocked, so they can't sign in until unblocked.Default: false.

Outputs

blockedtrue/false
Whether they're blocked from signing in
emailtext
Their email address
groupslist
The names of the user groups they're in
idnumber
The user's ID
last_visit_attext
When they last signed in; empty if never (ISO 8601, UTC)
nametext
Their name
registered_attext
When they were added (ISO 8601, UTC)
usernametext
What they sign in with
Example output
{
  "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

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

Outputs

deletedtrue/false
Whether it was trashed or deleted
idnumber
The article's ID
permanentlytrue/false
Whether it was deleted for good rather than trashed
titletext
The article's title
Example output
{
  "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

CategorycategorytextRequired
The category to delete.
Delete for goodpermanentlytrue/false
Delete it for good instead of moving it to the trash, where an administrator can restore it.Default: false.

Outputs

deletedtrue/false
Whether it was trashed or deleted
idnumber
The category's ID
permanentlytrue/false
Whether it was deleted for good rather than trashed
titletext
The category's name
Example output
{
  "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

UserusertextRequired
The user: their ID from another Joomla step, username or email address.

Outputs

deletedtrue/false
Whether the user was deleted
emailtext
Their email address
idnumber
The user's ID
nametext
Their name
usernametext
Their username
Example output
{
  "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

Categorycategorytext
Only articles in this category or the ones inside it.
Statusstatustext
Only articles with this status. Leave blank for published and unpublished ones.One of: published, unpublished, archived, trashed.
Searchsearchtext
Words in the title or alias. Start with content: to look in the text instead, such as content:volunteers.
Authorauthortext
Only articles by this user: their ID, username or email.
Tagtagtext
Only articles with this tag.
Featuredfeaturedtext
Only featured articles, or only ones that aren't.One of: yes, no.
Languagelanguagetext
Only articles in this language.
Changed sincechanged_sincedate and time
Only articles added or changed after this time.
Ordersorttext
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 manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

articleslist
The articles found
countnumber
How many are listed
has_moretrue/false
Whether there are more than were listed
Example output
{
  "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

Searchsearchtext
Words in their name, username or email address.
User groupgrouptext
Only users in this group.
Statusstatustext
Only active users, or only blocked ones.One of: active, blocked.
Joined sinceregistered_sincedate and time
Only users added after this time.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
has_moretrue/false
Whether there are more than were listed
userslist
The users found
Example output
{
  "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

ArticlearticletextRequired
The article's ID (a number, such as 42) from another Joomla step or the trigger, or its link on the site.

Outputs

access_leveltext
Who can see it, such as Public or Registered
aliastext
Its URL alias, the part of its web address made from the title
authortext
The name of the user who wrote it
author_aliastext
The name shown as its author instead, if one was given
author_idnumber
The ID of the user who wrote it
categorytext
The name of the category it's in
category_idnumber
The ID of the category it's in
contenttext
The whole article as HTML, its intro text first
created_attext
When it was added (ISO 8601, UTC)
edit_linktext
Where an administrator edits it in Joomla
featuredtrue/false
Whether it's featured
full_texttext
The text after the intro, as HTML; all of it if there is no intro
hitsnumber
How many times it has been viewed
idnumber
The article's ID
imagetext
The web address of its intro image; empty if it has none
intro_texttext
The intro, before the Read more break, as HTML; empty if it has none
languagetext
Its language code, such as en-GB, or * for all languages
linktext
Its address on the website
meta_descriptiontext
Its meta description, for search engines
publish_downtext
When it stops showing; empty if never (ISO 8601, UTC)
publish_uptext
When it starts showing on the site (ISO 8601, UTC)
statustext
published, unpublished, archived or trashed
tag_idslist
The IDs of its tags
tagslist
The names of its tags
texttext
The whole article as plain text, without HTML
titletext
The article's title
updated_attext
When it last changed (ISO 8601, UTC)
Example output
{
  "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

Searchsearchtext
Words in the category's name.
Statusstatustext
Only categories with this status. Leave blank for published and unpublished ones.One of: published, unpublished, archived, trashed.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

categorieslist
The categories
countnumber
How many are listed
has_moretrue/false
Whether there are more than were listed
Example output
{
  "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

ArticlearticletextRequired
The article's ID (a number, such as 42) from another Joomla step or the trigger, or its link on the site.
Titletitletext
A new title. Leave blank to keep it.
Textcontenttext
What the article says, in the format chosen. Leave blank to keep it.
Formatcontent_formattext
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 textintro_texttext
A short opening, shown in lists of articles with a Read more link to the text. Leave blank to keep it.
Categorycategorytext
A category to move it to. Leave blank to keep it.
Tagstagslist
Tags to put on it instead of the ones it has. Leave blank to keep them.
Statusstatustext
Publish, unpublish or archive it. Leave blank to keep it.One of: published, unpublished, archived.
Featuredfeaturedtext
Whether to feature it. Leave blank to keep it.One of: yes, no.
Start publishingpublish_update and time
When it starts showing on the site. Set a time ahead to schedule it.
Finish publishingpublish_downdate and time
When it stops showing on the site. Leave blank to keep showing it.
Languagelanguagetext
The language it's in, for a site in several languages. Defaults to all languages.
Accessaccesstext
Who can see it, such as Public or Registered. Defaults to the site's setting, usually Public.
Aliasaliastext
The part of its web address made from the title, such as spring-volunteer-day. Joomla makes one from the title if blank.
Meta descriptionmeta_descriptiontext
A sentence or two for search engines to show.
Imageimagetext
A picture to show with it: the path from 'Upload image', such as images/news/photo.jpg, or a web address.
Image descriptionimage_alttext
What the picture shows, for people who can't see it.

Outputs

access_leveltext
Who can see it, such as Public or Registered
aliastext
Its URL alias, the part of its web address made from the title
authortext
The name of the user who wrote it
author_aliastext
The name shown as its author instead, if one was given
author_idnumber
The ID of the user who wrote it
categorytext
The name of the category it's in
category_idnumber
The ID of the category it's in
created_attext
When it was added (ISO 8601, UTC)
edit_linktext
Where an administrator edits it in Joomla
featuredtrue/false
Whether it's featured
hitsnumber
How many times it has been viewed
idnumber
The article's ID
imagetext
The web address of its intro image; empty if it has none
languagetext
Its language code, such as en-GB, or * for all languages
linktext
Its address on the website
meta_descriptiontext
Its meta description, for search engines
publish_downtext
When it stops showing; empty if never (ISO 8601, UTC)
publish_uptext
When it starts showing on the site (ISO 8601, UTC)
statustext
published, unpublished, archived or trashed
tag_idslist
The IDs of its tags
tagslist
The names of its tags
titletext
The article's title
updated_attext
When it last changed (ISO 8601, UTC)
Example output
{
  "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

ImagefiletextRequired
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.
Folderfoldertext
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 namefile_nametext
What to call it, such as volunteers.jpg. Defaults to the file's own name.
If the name is takenif_existstext
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_typetext
Its type, such as image/jpeg
foldertext
The folder it's in, inside images; empty for images itself
heightnumber
Its height in pixels
nametext
The file's name
pathtext
Where it is on the site, such as images/news/photo.jpg: give this to an article's Image field
sizenumber
Its size in bytes
urltext
Its web address
widthnumber
Its width in pixels
Example output
{
  "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
}

On this page