Chatwoot · Schema

Article

Chatwoot Article schema

Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen Source

Properties

Name Type Description
id integer
content string The text content.
meta object
position integer
status integer
title string
slug string
views integer
portal_id integer
account_id integer
author_id integer
category_id integer
folder_id integer
associated_article_id integer To associate similar articles to each other, e.g to provide the link for the reference.
View JSON Schema on GitHub

JSON Schema

article.json Raw ↑ 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "content": {
      "type": "string",
      "description": "The text content."
    },
    "meta": {
      "type": "object"
    },
    "position": {
      "type": "integer"
    },
    "status": {
      "type": "integer",
      "enum": [
        "draft",
        "published",
        "archived"
      ]
    },
    "title": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "views": {
      "type": "integer"
    },
    "portal_id": {
      "type": "integer"
    },
    "account_id": {
      "type": "integer"
    },
    "author_id": {
      "type": "integer"
    },
    "category_id": {
      "type": "integer"
    },
    "folder_id": {
      "type": "integer"
    },
    "associated_article_id": {
      "type": "integer",
      "description": "To associate similar articles to each other, e.g to provide the link for the reference."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/article.json",
  "title": "Article",
  "description": "Chatwoot Article schema"
}