{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/events","auth":"required","results":{"codes":[]},"settings":"","params":[{"name":"email","type":"string","default":"test:::at:::sendsonar.com","desc":"The email of your customer","required":false,"in":"body","ref":"","_id":"5abec791a87acc0043388b58"},{"name":"phone_number","type":"string","default":"+13105551234","desc":"The phone number of your customer","required":false,"in":"body","ref":"","_id":"5abec791a87acc0043388b57"},{"name":"event_type","type":"string","default":"conversion","desc":"The event type. Must be a valid type (currently only \"conversion\". Custom types will be supported in the future.)","required":true,"in":"body","ref":"","_id":"5abec791a87acc0043388b56"},{"name":"event_properties","type":"object","default":"\"name\": \"Online Store Purchase\", \"value\": 25.00","desc":"State the name of your conversion and the value","required":false,"in":"body","ref":"","_id":"5abec791a87acc0043388b55"}],"examples":{"codes":[{"name":"Example via Phone Number","language":"curl","code":"curl 'https://www.sendsonar.com/api/v1/events' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"phone_number\": \"+13105551234\", \"event_type\": \"conversion\", \"event_properties\": {\"name\": \"Online Store Purchase\", \"value\": 25.00}}'\n"},{"name":"Example via Email","language":"curl","code":"curl 'https://www.sendsonar.com/api/v1/events' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"email\": \"[email protected]\", \"type\": \"conversion\", \"event_properties\": {\"name\": \"Online Store Purchase\", \"value\": 25.00}}'"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Custom Tracking Events","type":"endpoint","slug":"conversion","excerpt":"","body":"## **Conversions**\n\nConversions now allow our partners to define conversion events that can be tracked either from your system or within Sonar (lead bot, Calendly integration, etc).  This endpoint can either use a customer's phone number or email address to associate a conversion with that individual.","updates":[],"order":12,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5abec3a22ce15c0058d88909","project":"55208137623ff50d009b2bec","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55208138623ff50d009b2bf0","55494a226a82a10d00817ae5","55494ba7ee219b0d001743c8","55494bc1ee219b0d001743cc","56ead8c1df765617008bccaf","573a2073dd007d1700cf288f","579695b1f64c9f0e007cd76c","57969e3dfa1ff60e006a1274","579a4592fd9f3c0e008e4f4a","57ab9afe54fa780e006c5430","57b784f5b7ebd60e009cb4a6","58f686818193090f008cec76","59e79fbd4cf31900341d50c6","5b2436973fd93f0003dcf99d","5d824fb2ce98a801366098a2"],"_id":"55208137623ff50d009b2bef","createdAt":"2015-04-05T00:26:31.564Z","releaseDate":"2015-04-05T00:26:31.563Z","__v":15,"project":"55208137623ff50d009b2bec"},"category":{"sync":{"isSync":false,"url":""},"pages":["55494ad0ee219b0d001743bb","55494b05f452670d00ec0c29","55494b11ee219b0d001743bf","55494b20ee219b0d001743c1","55494b2bee219b0d001743c3","55494b4a6a82a10d00817af5","55494b686a82a10d00817af9","5549651ccd09b317005f8f50","55497273cd09b317005f8f86","554977f0c634cf2d001250a7","55b970eab42b610d00c9b2e3","5696f3688560a60d00e2c216","5696f91c59a6692d003fad50","5696f92c24490c3700170a2d","5696f9700b09a41900b24422"],"title":"Public API","slug":"public-api","order":3,"from_sync":false,"reference":true,"_id":"55494a226a82a10d00817ae5","createdAt":"2015-05-05T22:54:26.925Z","project":"55208137623ff50d009b2bec","version":"55208137623ff50d009b2bef","__v":15},"user":"59e51455df6835002e0f0f8f","createdAt":"2018-03-30T23:09:22.787Z","githubsync":"","__v":9,"parentDoc":null}

postCustom Tracking Events


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
string[email protected]
The email of your customer
phone_number:
string+13105551234
The phone number of your customer
event_type:
required
stringconversion
The event type. Must be a valid type (currently only "conversion". Custom types will be supported in the future.)
event_properties:
object"name": "Online Store Purchase", "value": 25.00
State the name of your conversion and the value

Examples


Documentation

## **Conversions** Conversions now allow our partners to define conversion events that can be tracked either from your system or within Sonar (lead bot, Calendly integration, etc). This endpoint can either use a customer's phone number or email address to associate a conversion with that individual.