Documentazione API Mokapen

Webhook

I webhook notificano la tua applicazione quando entità vengono create, aggiornate o eliminate in Mokapen. Usali per integrazioni event-driven invece del polling sulle REST API.

Panoramica

Registra un URL webhook e seleziona gli eventi da ricevere. Quando si verifica un evento, Mokapen invia una richiesta HTTP POST al tuo endpoint con payload JSON.

Gli endpoint di gestione webhook richiedono un Bearer token valido con gli scope appropriati.

Endpoint 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

Registrare un webhook

Invia una POST con URL di callback, organization ID ed eventi selezionati:

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"]
}

Sicurezza

Verifica le richieste webhook in ingresso sul tuo server. Usa solo endpoint HTTPS. Conserva i secret in modo sicuro e valida i payload prima di processarli.

Eventi webhook supportati

Registrando un webhook puoi sottoscrivere uno o più dei seguenti eventi:

  • 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

Hai bisogno di aiuto?