0

Create webhook subscription

by
Published Oct 17, 2025

Creates a webhook subscription to receive notifications when an item on a board is updated. Subscriptions are created per user, per board. You can create multiple subscriptions. We currently support all board items except tags, connectors, and comments.Required scope boards:read Rate limiting Level 2

Script miro Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Miro = {
3
  token: string;
4
};
5
/**
6
 * Create webhook subscription
7
 * Creates a webhook subscription to receive notifications when an item on a board is updated. Subscriptions are created per user, per board. You can create multiple subscriptions. We currently support all board items except tags, connectors, and comments.Required scope boards:read Rate limiting Level 2
8
 */
9
export async function main(
10
  auth: Miro,
11
  body: {
12
    boardId?: string;
13
    callbackUrl?: string;
14
    status?: "enabled" | "disabled";
15
  },
16
) {
17
  const url = new URL(
18
    `https://api.miro.com//v2-experimental/webhooks/board_subscriptions`,
19
  );
20

21
  const response = await fetch(url, {
22
    method: "POST",
23
    headers: {
24
      "Content-Type": "application/json",
25
      Authorization: "Bearer " + auth.token,
26
    },
27
    body: JSON.stringify(body),
28
  });
29
  if (!response.ok) {
30
    const text = await response.text();
31
    throw new Error(`${response.status} ${text}`);
32
  }
33
  return await response.json();
34
}
35