Mokapen API dokumentácia

Prehľad

Zaregistrujte webovú adresu webhooku a vyberte udalosti, ktoré chcete prijímať. Keď dôjde k udalosti, Mokapen odošle požiadavku HTTP POST do vášho koncového bodu s JSON dátovým zaťažením.

Koncové body správy webhooku vyžadujú platný token nosiča s príslušnými rozsahmi.

Koncový bod rozhrania Webhook API

ZÍSKAJTE /api/webhooks
POST /api/webhooks
PUT /api/webhooks/{webhook_id}
ODSTRÁNIŤ /api/webhooks/{webhook_id}
ZÍSKAJTE /api/webhooks/{webhook_id}/logs
ZÍSKAJTE /api/webhook-events

Nahrajte webhook

Odoslať POST s webovou adresou spätného volania, ID organizácie a vybratými udalosťami:

POST /api/webhooks
Autorizácia: Nositeľ YOUR_ACCESS_TOKEN
Content-Type: application/json

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

Bezpečnosť

Skontrolujte prichádzajúce požiadavky webhooku na vašom serveri. Používajte iba koncové body HTTPS. Uchovávajte tajomstvá bezpečne a overte užitočné zaťaženie pred ich spracovaním.

Podporované udalosti webhooku

Zaznamenaním webhooku sa môžete prihlásiť na odber jednej alebo viacerých z nasledujúcich udalostí: