0

Update webhook subscription

by
Published Oct 17, 2025

Updates the status or the callback URL of an existing webhook subscription.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
 * Update webhook subscription
7
 * Updates the status or the callback URL of an existing webhook subscription.Required scope boards:read Rate limiting Level 2
8
 */
9
export async function main(
10
  auth: Miro,
11
  subscription_id: string,
12
  body: { callbackUrl?: string; status?: "enabled" | "disabled" },
13
) {
14
  const url = new URL(
15
    `https://api.miro.com//v2-experimental/webhooks/board_subscriptions/${subscription_id}`,
16
  );
17

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