Mokapen API dokumentace

Webhooky

Webhooky upozorní vaši aplikaci, když jsou entity vytvořeny, aktualizovány nebo odstraněny v Mokapen. Použijte je pro integrace řízené událostmi namísto dotazování REST API.

Přehled

Zaregistrujte adresu URL webhooku a vyberte události, které chcete přijímat. Když dojde k události, Mokapen odešle požadavek HTTP POST do vašeho koncového bodu s datovou částí JSON.

Koncové body správy webhooku vyžadují platný token nosiče s příslušnými rozsahy.

Koncový bod rozhraní Webhook API

ZÍSKEJTE /api/webhooks
POST /api/webhooks
PUT /api/webhooks/{webhook_id}
ODSTRANIT /api/webhooks/{webhook_id}
ZÍSKEJTE /api/webhooks/{webhook_id}/logs
ZÍSKEJTE /api/webhook-events

Nahrajte webhook

Odeslat POST s adresou URL zpětného volání, ID organizace a vybranými událostmi:

POST /api/webhooks
Autorizace: nositel YOUR_ACCESS_TOKEN
Content-Type: application/json

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

Bezpečnost

Zkontrolujte příchozí požadavky webhooku na vašem serveru. Používejte pouze koncové body HTTPS. Bezpečně ukládejte tajemství a ověřte užitečné zatížení před jejich zpracováním.

Podporovány události webhooku

Nahráním webhooku se můžete přihlásit k odběru jedné nebo více z následujících událostí:

  • 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

Potřebujete pomoc?