Webhooks
Event pengiriman email
Terima notifikasi real-time tentang status pengiriman email. Atur URL webhook Anda di dashboard. Semua event ditandatangani dengan HMAC-SHA256 demi keamanan.
https://your-server.com/webhook/email/deliverySelalu verifikasi tanda tangan webhook. Buat secret webhook Anda di dashboard dan gunakan untuk memverifikasi request yang masuk. Hitung HMAC dari body request mentah, bukan dari JSON yang diserialisasi ulang.
Mulai cepat
Listener yang memverifikasi tanda tangan lalu memproses event. Balas dengan status 2xx setelah event diterima.
const express = require('express');
const crypto = require('crypto');
const app = express();
const WEBHOOK_SECRET = process.env.WEBHOOK_SECRET;
function verifySignature(rawBody, signature) {
if (!signature) return false;
const expected = 'sha256=' + crypto
.createHmac('sha256', WEBHOOK_SECRET)
.update(rawBody)
.digest('hex');
const a = Buffer.from(signature);
const b = Buffer.from(expected);
// timingSafeEqual throws when the lengths differ
return a.length === b.length && crypto.timingSafeEqual(a, b);
}
// express.raw keeps the body as a Buffer, exactly as it was sent
app.post('/webhook/email/delivery', express.raw({ type: 'application/json' }), (req, res) => {
if (!verifySignature(req.body, req.headers['x-webhook-signature'])) {
return res.status(401).json({ error: 'Invalid signature' });
}
const { event, emailId, data } = JSON.parse(req.body.toString('utf8'));
console.log('[Email Delivery] ' + event + ' - ' + emailId);
if (event === 'delivered') {
console.log(' Recipient: ' + data.recipientEmail);
} else if (event === 'bounced') {
console.log(' Reason: ' + data.reason);
}
res.status(200).json({ received: true });
});
app.listen(3001, () => {
console.log('Email delivery webhook listener on port 3001');
console.log(' POST /webhook/email/delivery');
});Header
X-Webhook-SignaturestringwajibTanda tangan HMAC-SHA256 dari body request. Format:
sha256=hex_digest
Pengujian dengan ngrok
Buka listener lokal Anda ke internet dan daftarkan URL yang dihasilkan sebagai URL webhook di dashboard.
ngrok http 3001
# Your webhook URL:
# https://abc123.ngrok.io/webhook/email/deliveryEvent
Setiap event adalah objek JSON dengan event, timestamp dan objek data. Buka sebuah event untuk melihat payload lengkap dan field-nya.
Pengiriman
Apa yang terjadi pada email dalam perjalanannya ke inbox.
queuedDikirim sekali saat email masuk ke antrean pengiriman, untuk setiap email: API, SMTP, dan kampanye. Dikirim lagi saat email dipindahkan ke IP atau server lain untuk dicoba ulang.
processingDikirim saat email lolos pemeriksaan kami dan akan segera dikirim ke server penerima.
deliveredDikirim saat server email penerima menerima email.
bouncedDikirim saat email ditolak permanen: alamatnya tidak ada, domainnya tidak bisa menerima email, atau kami berhenti mencoba.
spamDikirim saat server email penerima menolak email sebagai spam atau karena alasan kebijakan selama pengiriman.
retryingDikirim setiap kali email belum bisa dikirim dan akan dicoba lagi.
failedDikirim saat kami menyerah pada sebuah email setelah percobaan ulangnya habis.
return_pathDikirim saat pesan bounce (DSN) datang belakangan, setelah server penerima sempat menerima email. Kegagalan memindahkan email ke bounced. Pemberitahuan penundaan atau pengiriman hanya mengirim event ini.
Pelacakan
Apa yang dilakukan penerima setelah email sampai.
email_openedDikirim saat penerima membuka email dengan pelacakan open aktif. Berisi perangkat, IP, negara, dan apakah open datang melalui proxy.
email_clickedDikirim saat penerima mengklik tautan di email dengan pelacakan klik aktif. Berisi URL dan apakah itu klik pertama.
unsubscribeDikirim saat penerima berhenti berlangganan dari salah satu email Anda: di halaman unsubscribe, dengan tombol satu klik di kotak suratnya (Gmail, Yahoo, Outlook), atau lewat email melalui header List-Unsubscribe.
tracking_preferences_updatedDikirim saat penerima mengubah pilihan pelacakan open atau klik di halaman preferensi tracking. Penerima tetap menerima email Anda: ini bukan unsubscribe.
Endpoint Anda terlalu sering gagal? Lihat Daftar webhook untuk mengecek statusnya, atau Coba ulang semua yang gagal untuk mengantrekan ulang yang terlewat.