Webhooks

To get notified of some communication or platform events, ApiRTC can trigger WebHooks to your backend server.
WebHooks are triggered asynchronously.
To handle WebHooks, your backend needs to accept HTTP requests. When some event occurs, ApiRTC makes a POST HTTP request to the URL you have configured for your WebHooks.
The request includes details of the event. Your backend can then perform whatever logic is necessary.
Set the URL that should be called by the webhook in the ApiRTC Console > Company > Company account -> Settings -> WebHooks. (and don't forget to check the Activate checkbox !)
Example of a webhook payload corresponding to a conversationEnded event:
{
  event: 'update',
  time: 1632144306,
  object: 'conversation',
  objectId: '734e3a7b-eb17-4d3f-901d-bcff178b',
  props: {
    eventType: 'conversationEnded',
    name: 'TEST',
    finishedAt: '2021-09-20T13:25:06+00:00'
  }
}

ApiRTC REST APIs & Integration - Previous

Introduction

Last modified 3mo ago