Mokapen API -dokumentaatio

Webhooks

Webhookit ilmoittavat sovelluksellesi, kun entiteettejä luodaan, päivitetään tai poistetaan Mokapenissa. Käytä niitä tapahtumalähtöisiin integraatioihin REST-sovellusliittymien kyselyn sijaan.

Yleiskatsaus

Rekisteröi webhookin URL-osoite ja valitse vastaanotettavat tapahtumat. Kun tapahtuma tapahtuu, Mokapen lähettää HTTP POST -pyynnön päätepisteellesi JSON-hyötykuormalla.

Webhook-hallinnan päätepisteet vaativat kelvollisen siirtotietunnuksen, jolla on asianmukaiset laajuudet.

Webhook API -päätepiste

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

Nauhoita webhook

Lähetä POST, jossa on takaisinsoitto-URL-osoite, organisaatiotunnus ja valitut tapahtumat:

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

Turvallisuus

Tarkista saapuvat webhook-pyynnöt palvelimeltasi. Käytä vain HTTPS-päätepisteitä. Säilytä salaisuudet turvallisesti ja vahvista hyötykuormat ennen niiden käsittelyä.

Webhook-tapahtumia tuetaan

Tallentamalla webhookin voit tilata yhden tai useamman seuraavista tapahtumista:

  • 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

Tarvitsetko apua?