Word Press
Schema-driven source documentation.
WORDPRESS29 fields3 examples
Commonly Asked Questions
Assistant knowledge mapped to this source type from
assistant_knowledge.json.Required
Fields required for a valid configuration payload under `config.required`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| required | object | Yes | — | — | no extra properties |
| required.url | string | Yes | Base URL of the WordPress site (e.g., https://example.com) | — | format uri |
Masked
Sensitive fields under `config.masked` (secrets/credentials).
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| masked | object | Yes | — | — | no extra properties |
| masked.application_password | string | No | WordPress application password for authentication (optional) | — | — |
| masked.username | string | No | Username for authentication (optional for public content) | — | — |
Optional
Optional configuration fields under `config.optional`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| optional | object | No | — | — | no extra properties |
| optional.content | object | No | Content scope and filters for WordPress ingestion. | — | no extra properties |
| optional.content.fetch_pages | boolean | No | Whether to fetch pages | true | — |
| optional.content.fetch_posts | boolean | No | Whether to fetch blog posts | true | — |
| optional.content.post_status | array | No | Post status filters (requires authentication for non-public statuses) | ["publish"] | — |
| optional.content.post_status[] | enum | No | WordPress post status Allowed values: publish, future, draft, pending, private | — | — |
Examples
Reference payloads generated from shared source examples JSON.
Extract posts and pages from public WordPress site
Extract blog posts and pages from a public WordPress site without authentication
Schedule
{
"enabled": true,
"preset": "nightly",
"cron": "37 1 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "WORDPRESS",
"required": {
"url": "https://example.com"
},
"masked": {},
"optional": {
"content": {
"fetch_posts": true,
"fetch_pages": true
}
},
"sampling": {
"strategy": "LATEST",
"limit": 100
},
"detectors": [
{
"type": "BROKEN_LINKS",
"enabled": true
}
]
}Extract only blog posts
Extract only blog posts, excluding pages
Schedule
{
"enabled": true,
"preset": "daily",
"cron": "22 9 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "WORDPRESS",
"required": {
"url": "https://blog.example.com"
},
"masked": {},
"optional": {
"content": {
"fetch_posts": true,
"fetch_pages": false
}
},
"sampling": {
"strategy": "LATEST",
"limit": 200
}
}Full scan with authentication for private content
Scan all posts and pages including drafts using WordPress application password authentication
Schedule
{
"enabled": true,
"preset": "nightly",
"cron": "14 0 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "WORDPRESS",
"required": {
"url": "https://example.com"
},
"masked": {
"username": "admin",
"application_password": "your-application-password"
},
"optional": {
"content": {
"fetch_posts": true,
"fetch_pages": true,
"post_status": [
"publish",
"draft"
]
}
},
"sampling": {
"strategy": "ALL"
}
}