Dokumentasi API Mokapen

Webhook

Webhook memberi tahu aplikasi Anda ketika entitas dibuat, diperbarui, atau dihapus di Mokapen. Gunakan mereka untuk integrasi berbasis peristiwa alih-alih melakukan polling REST API.

Ringkasan

Daftarkan URL webhook dan pilih acara yang akan diterima. Ketika suatu peristiwa terjadi, Mokapen mengirimkan permintaan HTTP POST ke titik akhir Anda dengan payload JSON.

Titik akhir pengelolaan webhook memerlukan token Pembawa yang valid dengan cakupan yang sesuai.

Titik akhir API webhook

GET    /api/webhooks
POST   /api/webhooks
PUT    /api/webhooks/{webhook_id}
DELETE /api/webhooks/{webhook_id}
GET    /api/webhooks/{webhook_id}/logs
GET    /api/webhook-events

Rekam webhook

Kirim POST dengan URL panggilan balik, ID organisasi, dan acara yang dipilih:

POST /api/webhooks
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "url": "https://example.com/webhooks/mokapen",
  "org_id": 849,
  "events": ["task.created", "task.updated", "contact.created"]
}

Keamanan

Periksa permintaan webhook yang masuk di server Anda. Gunakan titik akhir HTTPS saja. Simpan rahasia dengan aman dan validasi muatan sebelum memprosesnya.

Acara webhook didukung

Dengan merekam webhook Anda dapat berlangganan satu atau beberapa acara berikut:

  • task.created
  • task.updated
  • task.deleted
  • project.created
  • project.updated
  • project.deleted
  • contact.created
  • contact.updated
  • contact.deleted
  • company.created
  • company.updated
  • company.deleted
  • ticket.created
  • ticket.updated
  • ticket.deleted
  • booking.created
  • booking.updated
  • booking.deleted
  • product.created
  • product.updated
  • product.deleted
  • service.created
  • service.updated
  • service.deleted
  • quote.created
  • quote.updated
  • quote.deleted
  • order.created
  • order.updated
  • order.deleted
  • deal.created
  • deal.updated
  • deal.deleted
  • appointment.created
  • appointment.updated
  • appointment.deleted
  • document.created
  • document.updated
  • document.deleted
  • campaign.created
  • campaign.updated
  • campaign.deleted

Apakah Anda memerlukan bantuan?