latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

webhook

Contact event

Webhook sent on each call (incoming and outgoing), it will allow you to transmit notes to the agent. The notes are located next to the contact's photo, in the information bubble of the call window. You can set custom information in the data object (refer to the object below).

To certify that the request was sent by Ringover, the x-ringover-webhook-signature header must be a JWT signed with the webhook key you can find in the Contact Call section of the webhook configuration page of Ringover dashboard, using algorithm HS512.

postWebhookcontact

Payload

eventstring
resourcestring
timestampnumber

Example payload

{
  "event": "contact",
  "resource": "call",
  "timestamp": 1554823493.762305,
  "data": {
    "call_id": 1234567890987654400,
    "direction": "inbound",
    "from_number": "33601020304",
    "to_number": "33101020304"
  }
}

Response

Successful operation

uuidstring uuid
firstnamestring
lastnamestring
companystring
urlstring
is_sharedboolean

Example response

{
  "uuid": "b55f949b-c49b-4354-b10a-c8c4cdbd8690",
  "firstname": "Jean-Pierre",
  "lastname": "De La Court",
  "company": "Ringover",
  "url": "https://mycrm.com/client/18192233",
  "data": {
    "key1": "value1",
    "key2": "value2",
    "keyN": "valueN"
  },
  "is_shared": true
}