Mokapen API документация

Преглед

Регистрирайте URL адрес на уебкукичка и изберете събития за получаване. Когато възникне събитие, Mokapen изпраща HTTP POST заявка до вашата крайна точка с JSON полезен товар.

Крайните точки за управление на Webhook изискват валиден носещ токен със съответните обхвати.

Крайна точка на API на Webhook

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

Запишете webhook

Изпратете POST с URL адрес за обратно извикване, идентификатор на организация и избрани събития:

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

Безопасност

Проверете входящите заявки за уеб кукичка на вашия сървър. Използвайте само HTTPS крайни точки. Съхранявайте тайните сигурно и валидирайте полезните данни, преди да ги обработите.

Поддържат се събития на Webhook

Чрез записване на webhook можете да се абонирате за едно или повече от следните събития: