Τεκμηρίωση Mokapen API

Webhooks

Τα Webhook ειδοποιούν την εφαρμογή σας όταν δημιουργούνται, ενημερώνονται ή διαγράφονται οντότητες στο Mokapen. Χρησιμοποιήστε τα για ενσωματώσεις που βασίζονται σε συμβάντα αντί για δημοσκόπηση REST API.

Επισκόπηση

Καταχωρίστε μια διεύθυνση URL webhook και επιλέξτε συμβάντα για λήψη. Όταν συμβαίνει ένα συμβάν, το Mokapen στέλνει ένα αίτημα HTTP POST στο τελικό σημείο σας με ωφέλιμο φορτίο JSON.

Τα τελικά σημεία διαχείρισης Webhook απαιτούν ένα έγκυρο διακριτικό φορέα με τα κατάλληλα πεδία.

Τελικό σημείο Webhook API

GET /api/webhooks
POST /api/webhooks
PUT /api/webhooks/{webhook_id}
ΔΙΑΓΡΑΦΗ /api/webhooks/{webhook_id}
GET /api/webhooks/{webhook_id}/logs
GET /api/webhook-events

Εγγραφή webhook

Αποστολή ΑΝΑΡΤΗΣΗΣ με επιλεγμένο URL επιστροφής κλήσης, αναγνωριστικό οργανισμού και συμβάντα:

POST /api/webhooks
Εξουσιοδότηση: Φορέας YOUR_ACCESS_TOKEN
Τύπος περιεχομένου: εφαρμογή/json

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

Ασφάλεια

Ελέγξτε τα εισερχόμενα αιτήματα webhook στον διακομιστή σας. Χρησιμοποιήστε μόνο τελικά σημεία HTTPS. Αποθηκεύστε τα μυστικά με ασφάλεια και επικυρώστε τα ωφέλιμα φορτία πριν τα επεξεργαστείτε.

Υποστηρίζονται συμβάντα Webhook

Με την εγγραφή ενός webhook μπορείτε να εγγραφείτε σε ένα ή περισσότερα από τα ακόλουθα συμβάντα:

  • 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

Χρειάζεστε βοήθεια;