# API and webhooks

> Read and write help articles with a REST API, get articles as Markdown or HTML, and get signed webhooks when articles publish or feedback comes in.

URL: https://office.greatwork.company/kb/features/api-and-webhooks
Last updated: 2026-11-21

A REST API for articles, categories and search, plus signed webhooks when articles are published, feedback arrives or a contact message comes in.

## REST API

Use an API key to list categories, list and fetch articles (as JSON, HTML or Markdown), create and update articles with a body in Markdown or HTML, publish, unpublish and archive them, run a search, and get suggested articles for a page URL.

## Webhooks

Get a signed POST when an article is published, updated, unpublished or deleted, when feedback or a contact message arrives, when an import finishes, and a daily digest of failed searches. Deliveries retry on failure and every attempt is logged.

## Zapier and Make

Point a webhook at a Zapier or Make "catch hook" to start a workflow, and call the API to create articles from one.

## Example: Release notes straight from a deploy

A team's deploy script sends `POST /api/v1/kb/articles` with the release notes as Markdown and `status: draft`. The support lead gets the draft, adds two screenshots and publishes. A `kb.article.published` webhook then posts the link to their team chat through Zapier.

## How to set it up

1. Create an API key in workspace settings and choose read or write scope.
2. Add a webhook endpoint and pick the events you want.
3. Use the signing secret to verify each delivery.

---

Office by Great Work. Questions or corrections: hello@greatwork.company
