> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetokb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> List, create, update, and delete webhooks.

A webhook sends article events to an endpoint you own. Every webhook command, reads included, needs the Manage webhooks permission. For fields and response details, see the [API reference](https://apidocs.neetokb.com/api/webhooks/list.md).

## List webhooks

This command lists webhooks. The secret is never shown.

```bash theme={"system"}
neetokb webhooks list
```

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |

## Show a webhook

This command shows one webhook.

```bash theme={"system"}
neetokb webhooks show 4b7a2d90-8e15-4c36-a9f1-3d6c0e8b5274
```

**Required arguments:**

* `<id>` - Webhook ID from `webhooks list`

## List webhook events

This command lists the events a webhook can subscribe to.

```bash theme={"system"}
neetokb webhooks events
```

## Create a webhook

This command creates a webhook.

```bash theme={"system"}
neetokb webhooks create \
  --endpoint https://example.com/hook \
  --secret s3cret \
  --event create --event publish
```

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--active` | `bool` | | `false` | Send events (--active=false pauses the webhook) |
| `--endpoint` | `string` | Yes | | URL that receives the events |
| `--event` | `stringArray` | | `[]` | Event to send: create, update, delete, publish or unpublish; repeat for several |
| `--secret` | `string` | | | Signing secret; it can be set but never read back |

`--event` takes `create`, `update`, `delete`, `publish` or `unpublish`. Repeat it for several events. The endpoint is unique in the workspace. The secret can be set but never read back.

## Update a webhook

This command changes a webhook. Only the flags you pass change.

```bash theme={"system"}
neetokb webhooks update 4b7a2d90-8e15-4c36-a9f1-3d6c0e8b5274 --active=false
```

**Required arguments:**

* `<id>` - Webhook ID from `webhooks list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--active` | `bool` | | `false` | Send events (--active=false pauses the webhook) |
| `--endpoint` | `string` | | | URL that receives the events |
| `--event` | `stringArray` | | `[]` | Event to send: create, update, delete, publish or unpublish; repeat for several |
| `--secret` | `string` | | | Signing secret; it can be set but never read back |

`--event` replaces the whole list of events. A webhook on a deprecated or expired payload version cannot be updated or activated. Delete it and create a new one.

## Delete a webhook

This command deletes a webhook.

```bash theme={"system"}
neetokb webhooks delete 4b7a2d90-8e15-4c36-a9f1-3d6c0e8b5274
```

**Required arguments:**

* `<id>` - Webhook ID from `webhooks list`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.