StableN/ASyncedN/A

Wordpress.org Integration

Updated Jun 30, 202618 viewsView on usehalo.com

In this guide we will cover:

  • What is the Wordpress.org Integration?
  • Connecting to a Wordpress.org Site
  • Importing Posts
  • Enabling the Halo Integrator

What is the Wordpress.org Integration?

The Wordpress.org integration can import posts from a self-hosted Wordpress site as Knowledge Base articles in Halo. 

Note: If the website is hosted by Wordpress, you must use the Wordpress.com integration instead.

Connecting to a Wordpress.org Site

In Configuration > Integrations, you will find the Wordpress.org module in the Documentation section. Hover over the module, and click the plus icon to enable it.

Fig 1. Enabling the Wordpress.org integration

Clicking into the module, you will see an option to "Add/Edit Wordpress Connections".

Fig 2. Navigating to connect to Wordpress.org 

Multiple Wordpress.org connections can be made; either choose an existing one to edit or click the "New" button.

Fig 3. Wordpress.org connection list

You will then be able to connect to the Wordpress site. 

  • Enabled: This will be enabled by default to allow import.
  • Connection Name: Reference for the connection.
  • Site Url: URL of the Wordpress.org site.
  • Only import Posts with this Tag: If set, only posts that match this tag will be imported.
  • Post Status to Import: If set, only posts that use this status will be imported.
  • Import categories of Posts as FAQ Lists: The category set against the post will be created as an FAQ list, and the article set against that list. "Owner" access control will be given to the agent who imports the post. Any other levels of access control must be manually given.
  • Default FAQ List: This will import all posts against this FAQ list. This will only show if the above setting is disabled.
  • Do not update FAQ Lists for previously imported Posts: If the category/default FAQ list changes and this is enabled, the article will stay in its originally assigned FAQ list instead of moving to the new one.
  • Use a Custom Wordpress endpoint: If enabled, a custom endpoint can be specified to retrieve the post data. This may be needed when using certain custom Wordpress themes. The endpoint must return all the listed fields for the import to run.

Fig 4. Configuring the site and post options

If you wish to retrieve non-public posts, you will need authenticate with Wordpress.org credentials. The username and password given must correspond with a Wordpress admin user.

Fig 5. Authenticating with Wordpress.org credentials

Importing Posts

Within the main section of the Wordpress.org module, click the "Import Wordpress Posts via API" button. Anything within the "Posts" section of the Wordpress.org site, that has note been filtered out by status or tag, will show in this import screen.

Fig 6. Importing posts via API

The posts will show in the corresponding FAQ list. The "Created by" field does not get set upon first import, but further updates to the same article/post will show the "Edited by" field. If article reviews are enabled, the "Next Review Date" will be set by the default number of days in Configuration > Knowledge Base > "Default Number Of Days Between Reviews".

Fig 7. Imported article and FAQ list

Articles can alternatively be manually imported with an XML file. This can be exported from Wordpress in the "Tools" section.

Fig 8. Importing posts via XML

Enabling the Halo Integrator

Posts can be imported once a day via the Halo integrator to create or update articles. In the main section of the module, select "Enable the Halo Integrator for the Wordpress.org integration".

Fig 9. Enabling the Halo integrator

Referenced by