Webhook

Dapatkan kunci API

Endpoint

POST/v1/webhooksGET/v1/webhooksDELETE/v1/webhooks/{id}POST/v1/webhooks/{id}/test

Mendaftarkan webhook

Daftarkan alamat https publik dan event yang Anda inginkan. Secret penandatanganan (whsec_…) ditampilkan hanya di jawaban ini. Satu aplikasi dapat memiliki hingga 10 webhook.

bash
curl -X POST https://api.sofia-post.com/api/v1/webhooks \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://app.example.com/hooks/sofia","events":["post.published","post.failed"]}'

Event

Eventdata
post.publishedpostId, establishmentId, platform, publishedAt, permalink
post.failedpostId, establishmentId, platform, error
webhook.testwebhookId

Sofia mengirim setiap event lewat POST sebagai JSON { id, type, createdAt, data }, dengan header Sofia-Event-Id, Sofia-Event-Type, dan Sofia-Signature. Hanya postingan yang dibuat aplikasi Anda yang diumumkan.

Memverifikasi tanda tangan

Sofia-Signature berbentuk t=<unix time>,v1=<hex>, dengan v1 adalah HMAC-SHA256 dari <t>.<raw body> menggunakan secret Anda. Verifikasi pada body mentah, dan tolak timestamp yang lama:

javascript
import { createHmac, timingSafeEqual } from 'node:crypto';

const isSignedBySofia = (header, rawBody, secret) => {
  const parts = Object.fromEntries(
    (header ?? '').split(',').map((part) => part.trim().split('=', 2)),
  );
  const timestamp = Number(parts.t);
  if (!Number.isInteger(timestamp) || typeof parts.v1 !== 'string') return false;
  if (Math.abs(Date.now() / 1000 - timestamp) > 300) return false;
  const expected = createHmac('sha256', secret).update(`${timestamp}.${rawBody}`).digest();
  const received = Buffer.from(parts.v1, 'hex');
  return received.length === expected.length && timingSafeEqual(received, expected);
};

Pengiriman dan percobaan ulang

  • Jawaban 2xx menandakan event terkirim. Jawaban lain, pengalihan (tidak pernah diikuti), atau 10 detik tanpa jawaban akan mencoba ulang setelah 1 menit, 5 menit, 30 menit, dan 2 jam, paling banyak 5 percobaan.
  • Event yang sama bisa datang dua kali: deduplikasi berdasarkan Sofia-Event-Id.
  • Jawab dengan cepat dan proses event setelahnya.

POST /v1/webhooks/{id}/test mengirim event webhook.test, ditandatangani seperti yang lain.