WordPress

1. Overview

WordPress is a world-renowned open-source content management system (CMS). It allows you to create everything from simple blogs to complex websites and powerful applications.

With the GoInsight WordPress node, you can integrate your website's content and user management directly into your automated workflows. This enables you to programmatically control the core components of your WordPress site, including:

• Content Management: Automate the creation, retrieval, and updating of posts and pages.
• User Administration: Manage your user base by creating, finding, retrieving, and updating user profiles.

2. Prerequisites

Before using this node, you must have a self-hosted WordPress website (WordPress.org), not a site hosted on WordPress.com. You will also need administrator-level access to your WordPress dashboard to install plugins and generate the necessary Application Password for authentication.

3. Credentials

For a detailed guide on how to obtain and configure your credentials, please refer to our official documentation: Credential Configuration Guide.

4. Supported Operations

The WordPress node centers on three resources: pages (static site content), posts (blog content), and users (accounts and profiles). Together they cover create, list, retrieve, and update flows against the WordPress REST API.

Summary

Operation Details

Create a Page

Creates a new WordPress page for static content such as “About” or “Contact.” Use Create a Post for blog posts. Creating a page runs normal WordPress hooks (for example save_post / wp_insert_post), so plugins that react on save may run. Typical failures include 403 without permission and 400 for invalid parameters; future status requires a valid date in AdditionalFields.

Input Parameters:

• Title: Page title (required). HTML is allowed. Example: About Our Services.

Options:

• Content: HTML body. Defaults to empty.
• Status: publish, future (requires date in AdditionalFields; missing or past dates can yield 400), draft (default), pending, or private.
• Slug: URL segment (lowercase, hyphens). Empty auto-generates from the title. Example: about-us.
• Parent: Parent page ID; 0 for top-level (default). Use a parent ID from listing or getting pages for hierarchy.
• MenuOrder: Order in menus and lists; lower numbers first (default 0).
• AdditionalFields: Extended fields: author (user ID), date (ISO8601; respect site timezone), excerpt, meta (custom key-value object), and other REST-supported keys as needed.

Output:

• Page (object): Created page. Text fields are nested (title, content, excerpt, guid with raw / rendered). Includes id, date, slug, status, link, author, parent, menu_order, etc.
• OriginalStatusCode (number): Raw HTTP status from WordPress (for example 201 created, 400 bad request).
• StatusCode (number): System status: 200 when the system handled the call (including API-level errors surfaced in ErrorMessage), 500 system error, -1 parameter validation error.
• ErrorMessage (string): Error text; empty when successful.

Find Pages

Returns a paginated list of pages matching optional search, status, author, sort, and AdditionalFilters. Up to 100 items per request. If Status is future, include After or ModifiedAfter (or related date keys) in AdditionalFilters to avoid empty results. Context edit requires appropriate admin permissions.

Options:

• Page: Results page index (default 1).
• PerPage: Page size, 1–100 (default 10).
• Search: Match string in title or content.
• Status: Filter by publish, future, draft, pending, or private.
• Author: Comma-separated author user IDs.
• OrderBy: Sort field, for example author, date, modified, title, menu_order, relevance (with Search), id, parent, slug, include.
• Order: asc or desc (default desc).
• AdditionalFilters: Advanced object (PascalCase keys) including Context (view / edit), date ranges (After, Before, ModifiedAfter, ModifiedBefore), Include / Exclude ID arrays, IncludeSlugs, Parent, ParentExclude, AuthorExclude, Offset, etc.

Output:

• PagesList (object-array): Page objects; use dot paths such as title.rendered and content.rendered.
• TotalPages (number): Total matching items.
• TotalPagesCount (number): Number of result pages given PerPage.
• CurrentPage (number): Current page index returned.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1 as above).
• ErrorMessage (string): Error text; empty when successful.

Get a Page

Loads a single page by PageId. Returns 404 if the page does not exist or is not visible to the caller, and supports password-protected pages via PostPassword.

Input Parameters:

• PageId: Numeric page ID (from the admin UI or from Find Pages).

Options:

• Context: view (default), embed (minimal fields), or edit (full/raw fields for administrative use).
• PostPassword: Password when the page is protected.

Output:

• PageData (object): Full page payload; rendered text lives under nested objects (for example PageData.title.rendered, PageData.content.rendered, PageData.excerpt.rendered).
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Update a Page

Applies a partial update to an existing page: only fields you send are changed. Requires a valid PageId; 404 / 403 are common when the ID is wrong or the user lacks permission. Extended properties such as comment/ping status, template, password, menu order, and excerpt can be passed in AdditionalFields.

Input Parameters:

• PageId: ID of the page to update (from Find Pages or Get a Page).

Options:

• Title: New title; HTML allowed.
• Content: New HTML body.
• Status: publish, future, draft, pending, or private.
• Slug: New URL-friendly slug.
• Author: New author user ID.
• FeaturedMedia: Featured image media ID.
• AdditionalFields: For example comment_status / ping_status (open / closed), template, password, menu_order, excerpt, and other supported REST fields.

Output:

• Page (object): Updated page; read rendered strings via Page.title.rendered and Page.content.rendered.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Create a Post

Creates a new post. Title and Content are required. The integration may treat duplicate titles idempotently (returning an existing post when appropriate). Omitting Status defaults to draft. 403 / 400 indicate permission or validation issues. For future status, supply a future date in AdditionalFields.

Input Parameters:

• Title: Post title; plain text or basic HTML.
• Content: Post body HTML.

Options:

• Status: publish, draft, pending, private, or future (requires date in AdditionalFields).
• Categories: Array of category IDs (from your categories source in WordPress).
• Tags: Array of tag IDs.
• FeaturedMedia: Featured image media ID; use 0 for none.
• AdditionalFields: Keys such as excerpt, slug, author, date (ISO8601), etc.

Output:

• Post (object): Full post object; common paths include Post.title.rendered, Post.content.rendered, Post.link, Post.status, Post.author.
• OriginalStatusCode (number): Raw HTTP status (0 if no request was sent, for example after validation failure).
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Find Posts

Lists posts with pagination, keyword Search, Status, Order / OrderBy, and AdditionalFilters (authors, categories, tags, dates, slugs, include/exclude IDs, sticky, etc.). Maximum 100 items per page. Private or draft content may require appropriate authentication and roles.

Options:

• Page: Page index (positive integer, default 1).
• PerPage: Page size, 1–100 (default 10).
• Search: Keyword match in titles and content.
• Status: publish (default), future, draft, pending, or private.
• Order: asc or desc (default desc).
• OrderBy: author, date, id, include, modified, parent, relevance, slug, or title (default date).
• AdditionalFilters: Object with keys such as author, author_exclude, categories, categories_exclude, tags, tags_exclude, after, before, modified_after, modified_before, slug, include, exclude, offset, sticky, etc.

Output:

• PostsList (object-array): Matching posts with nested title / content / excerpt objects, plus categories, tags, featured_media, etc.
• TotalPosts (number): Total posts matching the query.
• TotalPages (number): Number of pages for the current PerPage.
• CurrentPage (number): Page index returned.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Get a Post

Fetches one post by PostId. Use Find Posts for many results. 404 when missing; wrong PostPassword on protected posts can yield 403.

Input Parameters:

• PostId: Numeric post ID (from Find Posts or the admin editor URL).

Options:

• Context: view (default), embed (lightweight), or edit (full editor-oriented fields; needs permissions).
• PostPassword: Password for password-protected posts.

Output:

• PostData (object): Full post; use PostData.title.rendered and PostData.content.rendered for displayed strings.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Update a Post

Partially updates a post. PostId is required. If Status is future, include date in AdditionalFields. Categories and Tags, when provided, replace all existing assignments; to append, read current IDs with Get a Post, merge arrays, then call this action again. Updates trigger WordPress hooks (SEO plugins, notifications, etc.).

Input Parameters:

• PostId: ID of the post to update.

Options:

• Title: New title; HTML allowed; omit to leave unchanged.
• Content: New HTML body; omit to leave unchanged.
• Status: publish, future (requires date in AdditionalFields), draft, pending, or private.
• Author: Author user ID.
• Categories: Array of category IDs (replaces existing when set).
• Tags: Array of tag IDs (replaces existing when set).
• AdditionalFields: For example excerpt, date, slug, comment_status, sticky, featured_media, etc.

Output:

• Post (object): Updated post; nested fields use .rendered for human-readable text.
• UpdatedFields (string-array): Names of fields the server applied in this request.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Create a User

Creates a user with unique Username and Email, and a Password meeting site policy. The action checks for existing username or email and may return an existing user for idempotency. 400 errors often indicate duplicate username or invalid email.

Input Parameters:

• Username: Login name; must be unique.
• Email: Valid unique email.
• Password: Login password (sensitivity/complexity per WordPress settings).

Options:

• Name: Display name; defaults to Username when empty.
• Roles: String array such as administrator, editor, author, contributor, subscriber.
• AdditionalFields: Profile extensions, for example first_name, last_name, nickname, description, url, locale.

Output:

• User (object): Created user with id, username, name, email, roles, link, slug, etc.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Find Users

Returns users matching optional Search, Roles, sort fields, Fields projection, AdditionalFilters, and pagination. Listing users may return 403 without permission. Roles uses OR semantics across comma-separated roles in the string parameter.

Options:

• Page: Page index (default 1).
• PerPage: Page size, 1–100 (default 10).
• Search: Match against username, email, or display name.
• Roles: Comma-separated roles (OR). Standard roles: administrator, editor, author, contributor, subscriber.
• OrderBy: Sort key, for example id, display_name, name, registered_date, post_count, slug, include (default name).
• Order: asc (default) or desc.
• Fields: Comma-separated field list; supports nested paths (for example avatar_urls.24).
• AdditionalFilters: Object with keys such as context (view / embed / edit), slug, offset, exclude (comma-separated IDs), who (for example authors), etc.

Output:

• UsersList (object-array): User objects with id, username, name, email, roles, avatar_urls, etc.
• TotalUsers (number): Total matching users.
• TotalPages (number): Page count for the current PerPage.
• CurrentPage (number): Current page index.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

Get a User

Loads one user by UserId. The Context controls how much data is returned: edit exposes sensitive fields such as email and typically requires admin rights.

Input Parameters:

• UserId: Numeric user ID (from Find Users or the WordPress admin).

Options:

• Context: view (default, public-oriented fields), embed (minimal), or edit (full profile including email when permitted).

Output:

• UserData (object): Profile payload; availability of fields (for example email) depends on Context and permissions.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): 200 success path, -1 validation, 500 system error (per integration semantics).
• ErrorMessage (string): Error text; empty when successful.

Update a User

Partially updates a user. Only provided fields change. UserId is required. 403 / 404 / 400 map to permission, missing user, or invalid username/email. Extended attributes (for example first_name, password) go in AdditionalFields.

Input Parameters:

• UserId: ID of the user to update (from Find Users or Get a User).

Options:

• Username: New login name.
• Email: New email address.
• Name: New display name.
• Roles: Array of role strings (administrator, editor, etc.).
• AdditionalFields: Keys such as first_name, last_name, url, description, locale, nickname, slug, password.

Output:

• User (object): Updated user including roles and capabilities as returned by WordPress.
• UpdatedFields (string-array): Fields successfully updated in this call.
• OriginalStatusCode (number): Raw HTTP status from WordPress.
• StatusCode (number): System status (200, 500, or -1).
• ErrorMessage (string): Error text; empty when successful.

5. Example Usage

This section will guide you through creating a simple workflow to publish a new blog post on your WordPress site.

The workflow will look like this: Start -> Create a Post -> Answer.

Step-by-Step Guide

1. Add the Tool Node:
   • In the workflow canvas, click the + icon to add a new node.
   • Select the "Tool" tab in the pop-up panel.
   • Find and select WordPress from the tool list.
   • In the list of supported operations for WordPress, click Create a Post to add the corresponding node to the canvas.
2. Configure the Node:
   • Click on the newly added Create a Post node to open its configuration panel on the right.
   • Credentials: In the credentials field at the top of the panel, click the dropdown menu and select your pre-configured WordPress credential.
   • Parameters: Fill in the input parameters for the post.
   • Title: Enter a title for your new post, for example, "My First Automated Post".
   • Content: Write the body of your post. You can use HTML for formatting, for example,

     This is the content of my first post published via GoInsight!

     .
   • Status: To publish the post immediately, enter publish.
3. Run and Validate:
   • Once all required parameters are correctly filled, the error indicators on the workflow canvas will disappear.
   • Click the "Run" button in the top-right corner of the canvas to execute the workflow.
   • After a successful execution, you can click the log icon in the top-right corner to view the detailed input and output of the node. The output will contain the ID and URL of your new post.

Final Workflow

After completing these steps, your workflow is fully configured. When you run it, a new post will be published on your WordPress website.

6. FAQs

Q: Why am I getting a "401 rest_cannot_create" error?

A: This error usually indicates that your user account does not have sufficient permissions to perform the action (e.g., create a post or user). Please check the following in your WordPress dashboard:

• Ensure the user account associated with your Application Password has the correct role (e.g., Editor or Administrator).
• Verify that the role has the necessary capabilities to create or edit the content you are targeting.

Q: My request is failing. How do I get the Application Password?

A: You need to generate an Application Password from your WordPress admin dashboard. Go to Users -> Profile, and scroll down to the "Application Passwords" section. Enter a name for the application (e.g., "GoInsight") and click "Add New Application Password". Use the generated password in your GoInsight credential configuration. Note that you must have a plugin like "Application Passwords" or be on a recent version of WordPress that includes this feature.

Q: How do I find the ID for a category or tag?

A: You can find the ID for categories and tags in the WordPress admin dashboard. When you go to Posts -> Categories (or Tags), hover over a category/tag and look at the URL in your browser's status bar. The URL will contain tag_ID=X, where X is the ID you need.

7. Official Documentation

For more in-depth information about the WordPress REST API, please refer to the official Developer Handbook:

WordPress Official API Documentation