Event

2 min

events are called when recording a specific action in the application events are specific to contacts defined by their unique id { "name" "send an event", "method" "post", "url" "https //api successeve com/v1/track/event", "description" " ", "tab" "examples", "examples" { "languages" \[ { "id" "rjjlvajmcfcj2jq0mesew", "language" "curl", "code" "curl x post h \\"content type application/json\\" \\\\\n d '{\n \\"contact uid\\" \\"123456\\", \n \\"event uid\\" \\"user registration\\", \n \\"params\\" {\\"account uid\\" \\"78910\\", \\"display name\\" \\"registration\\"}\n }' \n'https //api salesmachine io/v1/track/event?api token=\<your api token>'", "customlabel" "" } ], "selectedlanguageid" "rjjlvajmcfcj2jq0mesew" }, "results" { "languages" \[ { "id" "siee5lll7vdzn0 mtsn i", "language" "200", "customlabel" "", "code" "{status \\"success\\"}" } ], "selectedlanguageid" "siee5lll7vdzn0 mtsn i" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "contact uid", "kind" "required", "type" "string", "description" "unique identifier referring to a contact, it must match a unique id in your application like database id or email address " }, { "name" "event uid", "kind" "required", "type" "string", "description" "event name in snake case format ", "children" \[] }, { "name" "params account uid", "kind" "optional", "type" "string", "description" "account id is a link to an account", "children" \[] }, { "name" "params display name", "kind" "optional", "type" "string", "description" "human readable event name ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "send a pageview", "method" "post", "url" "https //api successeve com/v1/track/event", "description" " ", "tab" "examples", "examples" { "languages" \[ { "id" "rjjlvajmcfcj2jq0mesew", "language" "curl", "code" "curl x post h \\"content type application/json\\" u 'your api token ' \\\\\n d '{\\"contact uid\\" \\"123456\\", \\"event uid\\" \\"pageview\\", \\"params\\" {\\"account uid\\" \\"78910\\", \\"visit url\\" \\"http //myproduct com/onboarding\\" }'\\\\\n'https //api successeve com/v1/track/event'", "customlabel" "" } ], "selectedlanguageid" "rjjlvajmcfcj2jq0mesew" }, "results" { "languages" \[ { "id" "siee5lll7vdzn0 mtsn i", "language" "200", "customlabel" "", "code" "{status \\"success\\"}" } ], "selectedlanguageid" "siee5lll7vdzn0 mtsn i" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "contact uid", "kind" "required", "type" "string", "description" "unique identifier referring to a contact, it must match a unique id in your application like database id or email address " }, { "name" "event uid", "kind" "optional", "type" "string", "description" "event name in snake case format ", "children" \[] }, { "name" "params account uid", "kind" "optional", "type" "string", "description" "account id is a link to an account", "children" \[] }, { "name" "params display name", "kind" "optional", "type" "string", "description" "human readable event name ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }