Mokapen API dokumentáció

Webhookok

A webhookok értesítik az alkalmazást, ha entitásokat hoznak létre, frissítenek vagy törölnek a Mokapenben. Használja őket eseményvezérelt integrációkhoz a REST API-k lekérdezése helyett.

Áttekintés

Regisztráljon egy webhook URL-t, és válassza ki a fogadni kívánt eseményeket. Amikor egy esemény bekövetkezik, a Mokapen HTTP POST-kérést küld a végpontnak JSON-adatterheléssel.

A Webhook-kezelési végpontokhoz érvényes hordozójogkivonat szükséges a megfelelő hatókörrel.

Webhook API végpont

SZEREZZE BE /api/webhooks
POST /api/webhooks
TELEPÍTSE el /api/webhooks/{webhook_id}
TÖRLÉS /api/webhooks/{webhook_id}
SZEREZZE BE /api/webhooks/{webhook_id}/logs
SZEREZZE BE /api/webhook-events

Webhook rögzítése

POST küldése visszahívási URL-lel, szervezetazonosítóval és kiválasztott eseményekkel:

POST /api/webhooks
Engedélyezés: YOUR_ACCESS_TOKEN hordozó
Tartalom típusa: Application/json

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

Biztonság

Ellenőrizze a bejövő webhook kéréseket a szerverén. Csak HTTPS-végpontokat használjon. Tárolja biztonságosan a titkokat, és feldolgozás előtt ellenőrizze a hasznos terheket.

Webhook események támogatottak

A webhook rögzítésével a következő események közül egy vagy többre feliratkozhat:

  • 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

Segítségre van szüksége?