---
title: "Create a webhook"
method: POST
path: "/webhooks"
tags: ["Webhooks"]
---

# Create a webhook

`POST /webhooks`

## Request

- Base URL: `https://api.mockflow.com/v1`
- URL: `https://api.mockflow.com/v1/webhooks`
- Auth: HTTP bearer

Subscribe an https endpoint to events, for one board or every board in the workspace. The
answer carries the signing secret, once. Events are sent only about boards the webhook's
creator can open. Use this from an integration that subscribes on behalf of its user, such as
a Zapier trigger, and delete the webhook when the user turns the trigger off.

## Request body

- object
  - `url` string, uri, required: Where to send events. https, to a public host.
  - `events` string[], required: Event types from GET /webhooks/events, a family such as "item.*", or "*" for all.
  - `boardId` string, nullable: One board only. Leave out for every board in the workspace.
  - `description` string

## Response `201`

Created. `secret` is shown here and when it is rotated, never in a list.

- object
  - `id` string
  - `url` string, uri
  - `events` string[]
  - `boardId` string, nullable: Null for every board in the workspace.
  - `description` string
  - `active` boolean
  - `pausedReason` string, nullable: Why MockFlow paused it
  - `createdBy` string, nullable: Events are sent only about boards this person can open.
  - `createdAt` string, date-time
  - `updatedAt` string, date-time, nullable
  - `secret` string

## Other responses

- `429`: Too many requests.
- `4XX`: An error. See the envelope and the code list on the Errors page.

---

[API](https://skmtc.dev/mockflow/apis/mockflow-boards-api.md) - [All operations](https://skmtc.dev/mockflow/apis/mockflow-boards-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mockflow/apis/mockflow-boards-api/revisions/1a890390518c?raw)