Webhooks

Webhooks let DocStar notify your own systems when pages in a collection change. Use them to trigger builds, post to Slack, sync content to another tool or keep an audit trail.

Untitled design (1).png

#

Add a webhook

  1. Open the collection and click Settings in the left sidebar.
  2. Go to the Webhooks tab.
  3. Under Add webhook, fill in:
    • Name: a label you'll recognise, such as "Release notifier".
    • Webhook URL: the endpoint that should receive events, such as https://example.com/hooks/docstar.
    • Events: one or more events from the list below.
  4. Click Add webhook.

DocStar sends an HTTP POST request to your URL each time a selected event happens. You need edit access to the collection to add or change webhooks.

#

Events

Event in the app Event name in the payload Sent when
On page created PAGE_CREATED A page is created
On page deleted PAGE_DELETED A page is deleted
On page title updated PAGE_UPDATED_TITLE A page is renamed
On page path updated PAGE_UPDATED_PATH A page's URL path changes
On page publish status updated PAGE_UPDATED_PUBLISH_STATUS A page is published or unpublished
On page content updated PAGE_UPDATED_CONTENT A page's content changes
#

What DocStar sends

Every request has a JSON body like this:

{
  "action": "PAGE_UPDATED_CONTENT",
  "collectionId": "your-collection-id",
  "payload": { },
  "enqueuedAt": "2026-10-17T09:30:00.000Z",
  "dispatchedAt": "2026-10-17T09:30:01.000Z"
}
  • action is the event name from the table.
  • payload holds details about the page that changed.
  • For PAGE_UPDATED_CONTENT, payload also includes previousHtml and updatedHtml (the content before and after the change) and a user object for the person who made it, when available.
#

Manage webhooks

The Configured webhooks table lists every webhook with its Name, URL, Events and Created at date. Under Manage you can:

  • Edit a webhook. Changes apply to future events only.
  • Delete a webhook. DocStar stops sending to that URL.
#

Webhook activity

The Webhook activity section shows who created, updated or removed webhooks in the collection, and when.

#

Tips and limits

  • Respond quickly with a 2xx status and do heavy work in the background. Slow endpoints can time out.
  • Failed deliveries are not retried. If you need every event, log what you receive and reconcile with the collection when needed.
  • Use separate webhooks for separate systems so you can change or remove one without affecting the others.
  • Embed collections have their own webhook settings. See Embed the Editor.
Built with DocStar