Publishing

Publish documents to GitHub, WordPress or a webhook. A connection holds the credentials; a publication says what goes where.

View as Markdown

Endpoints

The Publication object

idULID
workspaceIdstring· 1–64 chars
connectionIdULID
connectorstring
documentIdULID
includeSubpagesboolean
filterobjector null
Publish only documents whose property equals this (lists: contains it).
Show 2 fieldsHide fields
- propertystring· 1–128 chars
- equalsany
configobject
autoPublishboolean
lastRunAttimestampor null
itemsPublicationItem[]
Show 9 fieldsHide fields
- idULID
- documentIdULID
- statestring
  One ofdraftscheduledpublishingpublishedupdated_pendingfailedunpublisheddiverged
- externalIdstringor null
- externalUrlstringor null
- lastPublishedAttimestampor null
- lastErrorobjector null
- divergenceobjector null
  For diverged items: reason, base/ours/theirs (destination format), conflicts, marked text and the pull request.
- updatedAttimestamp
createdBystringor null
updatedBystringor null
createdAttimestamp
updatedAttimestamp

Example

{
  "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
  "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
  "connectionId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
  "connector": "string",
  "documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
  "includeSubpages": false,
  "filter": null,
  "config": {},
  "autoPublish": false,
  "lastRunAt": null,
  "items": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "state": "draft",
      "externalId": null,
      "externalUrl": null,
      "lastPublishedAt": null,
      "lastError": null,
      "divergence": null,
      "updatedAt": "2026-11-12T09:30:00.000Z"
    }
  ],
  "createdBy": null,
  "updatedBy": null,
  "createdAt": "2026-11-12T09:30:00.000Z",
  "updatedAt": "2026-11-12T09:30:00.000Z"
}