Webhook

Webhook memberi tahu layanan Anda setiap kali sesuatu berubah di MyPlan. Saat tugas, proyek, atau komentar dibuat, diubah, atau dihapus, MyPlan mengirim permintaan POST berisi JSON ke URL yang Anda tentukan. Gunakan webhook untuk menyinkronkan data ke sistem lain, memicu otomatisasi, atau mengirim notifikasi ke alat internal.

Halaman ini menjelaskan cara mengaturnya, format payload, header, dan cara memverifikasi tanda tangan.

Event yang tersediaSalin tautan bagian

Di dialog webhook, Anda bisa mencentang event satu per satu atau memilih semua untuk seluruh event dalam satu grup. Pilih minimal satu event. Event ping hanya dikirim oleh tombol Tes.

Langkah-langkahSalin tautan bagian

Cara pengiriman bekerjaSalin tautan bagian

• Setiap pengiriman adalah POST JSON dengan header nama event, ID pengiriman yang unik, dan tanda tangan.
• Tanda tangan adalah sha256= diikuti HMAC-SHA256 heksadesimal dari body mentah, dengan kunci rahasia webhook. Hitung di sisi Anda dan bandingkan dalam waktu konstan. Lihat Memverifikasi tanda tangan.
• Pengiriman habis waktu setelah 10 detik dan pengalihan (redirect) tidak diikuti.
• Setiap respons 2xx dihitung Terkirim; selain itu (atau tanpa respons) dihitung Gagal.
• Pengiriman event yang gagal dicoba ulang otomatis setelah 1 menit, 5 menit, dan 30 menit (paling banyak empat percobaan). Di Pengiriman, percobaan ulang ditandai percobaan ke-2 dan seterusnya, dan pengiriman gagal yang masih punya jadwal menampilkan dicoba lagi beserta waktunya.
• Kirim ulang mengirim payload yang sama sekarang juga dan membatalkan percobaan ulang otomatis yang masih menunggu untuk event itu. Pengiriman Tes tidak dicoba ulang otomatis.
• Hanya webhook yang aktif yang menerima event.

Isi data per eventSalin tautan bagian

Bentuk payloadSalin tautan bagian

Setiap pengiriman membungkus data event dalam amplop yang sama:

{
  "id": "0193a6f2-7c1e-7b40-9d2a-5f1e8c3b2a10",
  "event": "work_item.updated",
  "workspaceId": "0193a6f2-0000-7000-8000-000000000001",
  "createdAt": "2026-11-11T09:30:00Z",
  "data": {
    "id": "0193a6f2-1111-7000-8000-000000000002",
    "reference": "WEB-42",
    "title": "Perbaiki halaman login",
    "statusId": "0193a6f2-2222-7000-8000-000000000003",
    "statusCategory": "active",
    "priority": 3,
    "assigneeIds": ["0193a6f2-3333-7000-8000-000000000004"],
    "dueOn": "2026-11-20"
  }
}

Objek work item di data berisi data lengkap work item (contoh di atas dipersingkat). Objek komentar berisi id, taskId, authorId, bodyHtml, createdAt, dan editedAt.

HeaderSalin tautan bagian

Memverifikasi tanda tanganSalin tautan bagian

Rahasia webhook (diawali whsec_) ditampilkan sekali saat webhook dibuat atau saat Anda memilih Ganti rahasia. Hitung HMAC-SHA256 dari body mentah (byte persis seperti yang diterima, sebelum diparse) dengan rahasia itu sebagai kunci, lalu bandingkan dengan header dalam waktu konstan.

import { createHmac, timingSafeEqual } from "node:crypto";
import express from "express";

const app = express();
const SECRET = process.env.MYPLAN_WEBHOOK_SECRET; // whsec_...

app.post("/myplan", express.raw({ type: "application/json" }), (req, res) => {
  const expected = "sha256=" + createHmac("sha256", SECRET).update(req.body).digest("hex");
  const got = req.get("X-MyPlan-Signature") ?? "";
  const ok = got.length === expected.length && timingSafeEqual(Buffer.from(got), Buffer.from(expected));
  if (!ok) return res.status(401).end();

  const event = JSON.parse(req.body.toString("utf8"));
  console.log(event.event, event.data);
  res.status(204).end();
});

app.listen(3000);

Mengelola webhookSalin tautan bagian

Setiap webhook di daftar menampilkan URL, event yang dipilih, status pengiriman terakhir (Pengiriman terakhir berhasil atau Pengiriman terakhir gagal), dan Rahasia berakhiran … empat karakter terakhir rahasianya.

Menambah, mengubah, menghapus, dan mengganti rahasia webhook tercatat di log audit.

TipsSalin tautan bagian

• Balas secepat mungkin dengan 2xx, lalu proses event di antrean Anda sendiri agar tidak terkena batas 10 detik.
• Simpan id event dari payload dan abaikan duplikat, karena percobaan ulang dan Kirim ulang bisa mengirim event yang sama lebih dari sekali (header ID pengiriman berbeda di setiap percobaan).
• Ganti rahasia secara berkala atau segera jika rahasia bocor.
• Webhook ini untuk event tugas, proyek, dan komentar. Untuk menautkan commit dan pull request, gunakan integrasi GitHub dan GitLab.

IzinSalin tautan bagian

Mengelola webhook membutuhkan peran Admin atau Pemilik workspace (izin webhook.manage). Anggota lain melihat pesan Hanya admin workspace yang dapat melihat ini.

Ketersediaan paketSalin tautan bagian

Webhook tersedia di paket Business ke atas. Lihat Paket dan tagihan.

Lewat MCPSalin tautan bagian

Belum ada tool MCP untuk mengelola webhook.

TerkaitSalin tautan bagian

• GitHub dan GitLab
• Log audit
• Izin per peran