diff --git a/docs/_config.yml b/docs/_config.yml index d5a83a62d..eb89b4bdf 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -110,6 +110,8 @@ sidebar: url: /v5/integrating/counts/ - title: Moderating via Slack url: /v5/integrating/slack/ + - title: Event tracking + url: /v5/integrating/events/ - title: SEO & iframes url: /v5/seo/ - title: API diff --git a/docs/source/version-5-events.md b/docs/source/version-5-events.md new file mode 100644 index 000000000..e8e8e480a --- /dev/null +++ b/docs/source/version-5-events.md @@ -0,0 +1,32 @@ +--- +title: Event Tracking +permalink: /v5/integrating/events/ +--- + +The Coral embed script can emit events to the analytics tool of your choice. Common user actions, such as successfully posting a comment, posting a reaction, or changing a setting are all capturable with events. + +## Analytics Tool Integration + +To enable event tracking, modify your embed script to subscribe to the events hook. You will also need to add code to your page that sends the events to your analytics system. The particular way you send this will depend on what tool you’re using. Refer to your tool’s API and docs to determine this. + +In this example, we’re logging all events to the console as well as sending the `createComment.success` event. + +```js + +``` + + + +## Available Events + +A complete list of trackable events is available on GitHub: https://github.com/coralproject/talk/blob/master/CLIENT_EVENTS.md \ No newline at end of file