{"__v":0,"_id":"5719767ec863120e0012a058","category":{"__v":0,"_id":"5719767ec863120e0012a045","project":"56008ba98c0c9d0d00dcaeb0","version":"5719767ec863120e0012a042","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-25T21:10:29.130Z","from_sync":false,"order":0,"slug":"api","title":"API Documentation"},"parentDoc":null,"project":"56008ba98c0c9d0d00dcaeb0","user":"56008b651503430d007cc929","version":{"__v":3,"_id":"5719767ec863120e0012a042","hasDoc":true,"hasReference":true,"project":"56008ba98c0c9d0d00dcaeb0","createdAt":"2016-04-22T00:55:26.295Z","releaseDate":"2016-04-22T00:55:26.295Z","categories":["5719767ec863120e0012a043","5719767ec863120e0012a044","5719767ec863120e0012a045","5719767ec863120e0012a046","5719767ec863120e0012a047","5719767ec863120e0012a048","5719767ec863120e0012a049","57f45a18da14e71700d12e4a","582b71b15403840f008c0410"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-08T03:37:29.359Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":6,"body":"We use verbs to distinguish between different types of events. This page contains a list of verbs which hold special semantic meaning to us. In addition to these you can send any verb you like.\n\nWhen you send us an event, we require you to send a \"verb\". The API clients handle this for you. A verb is the action that the user has taken on your site - in English, and in the present/active tense. For example, `log-in` is the verb from _\"Lucy logged in to our website\"_.\n\nRead also:\n\n  * [What Events Should I Track?](doc:what-events-should-i-track) \n  * [\"Was This You?\" notifications. When and where do you send them?](doc:was-this-you-notifications-when-and-where)\n\n## Authentication\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Verb\",\n    \"h-1\": \"Meaning\",\n    \"0-0\": \"`log-in`\",\n    \"0-1\": \"When your user logs in to your app\",\n    \"1-0\": \"`log-out`\",\n    \"2-0\": \"`log-in-denied`\",\n    \"3-0\": \"`log-in-challenge`\",\n    \"4-0\": \"`authentication-challenge`\",\n    \"5-0\": \"`authentication-challenge-pass`\",\n    \"6-0\": \"`authentication-challenge-fail`\",\n    \"1-1\": \"When your user logs out of your app\",\n    \"7-0\": \"`email-update`\",\n    \"8-0\": \"`password-update`\",\n    \"2-1\": \"A log in attempt was denied (wrong username, wrong password, etc)\",\n    \"3-1\": \"A log in was challenged (e.g. to provide a 2FA code)\",\n    \"4-1\": \"An authenticated session was challenged (e.g. the user has to re-enter their password before performing sensitive actions)\",\n    \"5-1\": \"The authentication challenge was passed\",\n    \"6-1\": \"The authentication challenge failed\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n## Account Management\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Verb\",\n    \"h-1\": \"Meaning\",\n    \"0-0\": \"`email-update`\",\n    \"0-1\": \"The user updated their email address\",\n    \"1-0\": \"`password-update`\",\n    \"1-1\": \"The user updated their password\",\n    \"2-0\": \"`two-factor-disable`\",\n    \"2-1\": \"The user disabled Two Factor Authentication on their account\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Password Reset\nMany websites allow users who have forgotten their password to reset it, often via email.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Verb\",\n    \"h-1\": \"Meaning\",\n    \"0-0\": \"`password-reset-request`\",\n    \"0-1\": \"Someone (maybe the user) made a request to reset an account's password\",\n    \"1-0\": \"`password-reset`\",\n    \"1-1\": \"The user reset their password\",\n    \"2-0\": \"`password-reset-fail`\",\n    \"2-1\": \"The user was unable to reset their password (e.g. it was too short, the reset password token had expired, etc)\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## General\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Verb\",\n    \"h-1\": \"Meaning\",\n    \"0-0\": \"`access`\",\n    \"0-1\": \"The user accessed something (e.g. a web page)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"You can add tracking all over your app, and we'll use the events to build up a behavioural profile. However we will *only* send a notification after a `log-in` event looks suspicious. [Find out why](doc:was-this-you-notifications-when-and-where)\",\n  \"title\": \"Login Intelligence is what we do!\"\n}\n[/block]\n# What about my own custom verbs?\n\nGo for it! The more data you send, the better we learn. In general we try to stick to lowercase dash-separated present tense verbs.","excerpt":"Verbs are what we use to track different types of events","slug":"verbs","type":"basic","title":"Verbs (Event Types)"}

Verbs (Event Types)

Verbs are what we use to track different types of events

We use verbs to distinguish between different types of events. This page contains a list of verbs which hold special semantic meaning to us. In addition to these you can send any verb you like. When you send us an event, we require you to send a "verb". The API clients handle this for you. A verb is the action that the user has taken on your site - in English, and in the present/active tense. For example, `log-in` is the verb from _"Lucy logged in to our website"_. Read also: * [What Events Should I Track?](doc:what-events-should-i-track) * ["Was This You?" notifications. When and where do you send them?](doc:was-this-you-notifications-when-and-where) ## Authentication [block:parameters] { "data": { "h-0": "Verb", "h-1": "Meaning", "0-0": "`log-in`", "0-1": "When your user logs in to your app", "1-0": "`log-out`", "2-0": "`log-in-denied`", "3-0": "`log-in-challenge`", "4-0": "`authentication-challenge`", "5-0": "`authentication-challenge-pass`", "6-0": "`authentication-challenge-fail`", "1-1": "When your user logs out of your app", "7-0": "`email-update`", "8-0": "`password-update`", "2-1": "A log in attempt was denied (wrong username, wrong password, etc)", "3-1": "A log in was challenged (e.g. to provide a 2FA code)", "4-1": "An authenticated session was challenged (e.g. the user has to re-enter their password before performing sensitive actions)", "5-1": "The authentication challenge was passed", "6-1": "The authentication challenge failed" }, "cols": 2, "rows": 7 } [/block] ## Account Management [block:parameters] { "data": { "h-0": "Verb", "h-1": "Meaning", "0-0": "`email-update`", "0-1": "The user updated their email address", "1-0": "`password-update`", "1-1": "The user updated their password", "2-0": "`two-factor-disable`", "2-1": "The user disabled Two Factor Authentication on their account" }, "cols": 2, "rows": 3 } [/block] ## Password Reset Many websites allow users who have forgotten their password to reset it, often via email. [block:parameters] { "data": { "h-0": "Verb", "h-1": "Meaning", "0-0": "`password-reset-request`", "0-1": "Someone (maybe the user) made a request to reset an account's password", "1-0": "`password-reset`", "1-1": "The user reset their password", "2-0": "`password-reset-fail`", "2-1": "The user was unable to reset their password (e.g. it was too short, the reset password token had expired, etc)" }, "cols": 2, "rows": 3 } [/block] ## General [block:parameters] { "data": { "h-0": "Verb", "h-1": "Meaning", "0-0": "`access`", "0-1": "The user accessed something (e.g. a web page)" }, "cols": 2, "rows": 1 } [/block] [block:callout] { "type": "success", "body": "You can add tracking all over your app, and we'll use the events to build up a behavioural profile. However we will *only* send a notification after a `log-in` event looks suspicious. [Find out why](doc:was-this-you-notifications-when-and-where)", "title": "Login Intelligence is what we do!" } [/block] # What about my own custom verbs? Go for it! The more data you send, the better we learn. In general we try to stick to lowercase dash-separated present tense verbs.