Before you start
Neo calls your Dashboard from the internet, athttps://<your dashboard>/wp-json/mainwp/v2/. The WordPress site that runs the Dashboard must answer there over HTTPS with a certificate from a public authority. If you only allow known addresses, allow Neo’s IP addresses.
- Use MainWP Dashboard 5 or later, which has the REST API v2.
- In WordPress, open Settings > Permalinks and choose any option except Plain. The REST API needs it.
- On Apache, a server that drops the
Authorizationheader makes MainWP refuse every key. AddSetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1to the site’s.htaccessif your key is refused. - If your Dashboard sits behind Cloudflare Access, create a service token for Neo in Cloudflare Zero Trust (Access > Service credentials > Service tokens) and add a Service Auth policy for it to the Dashboard’s Access application. Keep the token’s Client ID and Client Secret for step 2.
- Assign each site to its client in MainWP, so an agent on a client’s ticket can reach the client’s sites.
1. Create the API key
1
Open API Keys
In WordPress, open MainWP Dashboard > API Access > API Keys and click Add API Keys.
2
Create a key for Neo
Name it Neo and give it the Read permission. Add Write & Delete only if your agents should change sites, plugins or updates.
3
Copy the key
Copy the API key (the Bearer token) and click Save API Key. MainWP shows the key only once.
2. Add the key in Neo
1
Open Integrations
In the Neo Dashboard, open Integrations and find the MainWP card, under Other.
2
Save the settings
Enter your Dashboard’s URL (for example
https://dashboard.example.com, or the folder WordPress lives in, such as https://example.com/wp) and the API key. If the Dashboard is behind Cloudflare Access, also enter the service token’s Client ID and Client Secret. Click Save settings. Neo counts your sites with them before saving, so a wrong URL or key is rejected straight away.3. Turn MainWP on per agent
Open the agent, go to its Tools & Settings tab, click Other, and expand the MainWP block. Pick one of its Presets, or set each area yourself. Every area can be Disabled, Read Only or Read / Write.
For a WordPress ticket agent that only looks up and describes sites, pick Read Only.
See MainWP API for what the agent can read and change.
