Skip to content
Headless Comments

Sites

A site is a collection of pages that you want to enable comments on. You can have up to 2 sites, and each site can have an unlimited number of pages.

General settings

When you create a new site, you can configure the following settings:

  • Name: The name of your site.
  • URL: The URL of your site.
  • Allow comments: Enable comments on all pages by default.
  • Allow reactions: Enable reactions on all pages and comments by default.
  • Hold comments for moderation: Hold all comments for moderation before they are published.

Sometimes you may want to disable comments on a specific page. You can do this by setting the allow comments to false on the page’s settings.

Rules

Rules allow you to automatically remove comments that match specific criteria. You can create rules based on the following criteria:

  • Author: The author’s name or email address.
  • Content: The comment’s content.

When an incoming comment matches a rule, it will be automatically removed before it enters your dashboard.

Notifications

You can configure notifications to receive an email when a new comment or author is added to your site, or to receive a daily, weekly, or monthly summary of comments.

Danger zone

In the danger zone, you can delete your site. Deleting a site will permanently remove all Pages, Rules, Comments and Authors associated with it. This action cannot be undone.

Via the API

List all sites

Get all sites within your Team

Request

GET /sites

Response

{
  "data": [
    {
      "id": "01j509cg4wwxtdtef3xws5kgf2",
      "created_at": "2024-08-11T08:37:54.000000Z",
      "updated_at": "2024-08-11T08:37:54.000000Z",
      "name": "Headless Comments",
      "url": "https://headlesscomments.io",
      "is_active": true,
      "hold_comments_for_moderation": true,
      "allow_comments": true,
      "user_id": "01j4sjct4ra51vskjhs3r257wz",
      "team_id": "01j4sjct8ps0dntdjthexpqwxh"
    }
  ]
}

Get a site

Get a single site by ID

Request

GET /sites/:id

Response

{
  "id": "01j509cg4wwxtdtef3xws5kgf2",
  "created_at": "2024-08-11T08:37:54.000000Z",
  "updated_at": "2024-08-11T08:37:54.000000Z",
  "name": "Headless Comments",
  "url": "https://headlesscomments.io",
  "is_active": true,
  "hold_comments_for_moderation": true,
  "allow_comments": true,
  "user_id": "01j4sjct4ra51vskjhs3r257wz",
  "team_id": "01j4sjct8ps0dntdjthexpqwxh"
}