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

9da73dd2f99e

webhook

Contact Search event

The webhook is triggered during a search on myringover (in the smartdialer, on contacts tabs, ...). In order to get from your API the contact's informations and numbers.

To certify that the request was sent by Ringover, the Authorization header must be equal to the webhook key you can find in the webhook configuration page of Ringover dashboard.

postWebhookcontact_search

Payload

eventstring
ressourcestring
timestampnumber

Example payload

{
  "event": "contact",
  "ressource": "search",
  "timestamp": 1554823493.762305,
  "data": {
    "query_search": "Jean",
    "user_id": 123456
  }
}

Response

Successful operation

firstnamestring
lastnamestring
companystring
urlstring

Example response

[
  {
    "firstname": "Jean-Pierre",
    "lastname": "De La Court",
    "company": "Ringover",
    "url": "https://mycrm.com/client/18192233",
    "numbers": [
      {
        "number": 33184800000,
        "type": "mobile"
      }
    ]
  }
]