{"_id":"53844558a43e08da4677be14","category":{"_id":"53844558a43e08da4677be13","pages":["53844558a43e08da4677be14","54211ad2f980dee664db9fc5","54212689f980dee664db9fc9","5421d851f980dee664db9ffe","54504d643c6f700800a9b4de","548f7589a8f6730b004b34b3","554a9af6b4322819002b6a1b","55a44d8b1fd6fb0d00d6fb2a"],"project":"53844557a43e08da4677be0e","version":"53844558a43e08da4677be12","__v":14,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-05-27T07:57:12.144Z","from_sync":false,"order":0,"slug":"general-api-documentation","title":"General API Documentation"},"is_link":false,"project":"53844557a43e08da4677be0e","version":{"_id":"53844558a43e08da4677be12","__v":8,"project":"53844557a43e08da4677be0e","createdAt":"2014-05-27T07:57:12.136Z","releaseDate":"2014-05-27T07:57:12.136Z","categories":["53844558a43e08da4677be13","538619e1ef91f96d49aa1a0b","541e82877eb16bb64f83c0ca","5445a073c3eb3808000c76b2","5445a098c3eb3808000c76b3","54bb05ab522f03150054d9e8","54bb05cf9741c81500078f73","55b7d0e5568be2230092bb92"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"false","version_clean":"1.0.0","version":"1.0"},"tags":[],"user":"5384345d90c19d5e43a8170c","__v":50,"comments":[],"updates":["53f293bac0ebe66a2623c562","543240a29022c60800e63b71","56f1a4789791b22d0077ba21"],"next":{"pages":[],"description":""},"createdAt":"2014-05-27T07:57:12.152Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"settings":"","try":true,"auth":"never","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Two types of Data in Knowtify\"\n}\n[/block]\nThere are two main categories data that you can bring into your Knowtify account - Contact-level Data and Global Data.\n\n**1. CONTACT-LEVEL DATA**\n\nThis is the most common type of data that you will bring into Knowtify. This represents any attribute attached to a specific contact in your system. The only required attribute for a contact in Knowtify is an email address - you can't create a contact without an email address. \n\nBut most commonly, contacts in Knowtify will have at least an email and name - as well as any piece of data associated with that contact that you will want to insert into your emails OR use to segment your emails. A typical contact record in Knowtify will look something like this;\n[block:image]\n{\n  \"images\": [\n    {\n      \"caption\": \"\",\n      \"image\": [\n        \"https://files.readme.io/GlYfred8SvmsvSnQ14PA_contact%20record.jpg\",\n        \"contact record.jpg\",\n        \"556\",\n        \"595\",\n        \"#e6e5e3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**2. GLOBAL DATA**\n\nGlobal Data, on the other hand, represents specific pieces of data that are NOT associated with a specific contact. This is data that may be relevant across your entire user base. For example, the typical blog or content site will store its blog posts (and related attributes like title, url, image, excerpt, etc) as Global Data points so they can be shared across all subscribers to its emails.  \n\nGlobal Data can be accessed in the Data tab of your Knowtify account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Ways to integrate data\"\n}\n[/block]\nThere are several ways to bring your data into Knowtify. They include:\n\n1 - **Uploading via CSV or JSON files**\n\nThe simplest way to bring data into your Knowtify is to upload a CSV of JSON file. You can do this right from the [People tab](http://www.knowtify.io/contacts). Learn more [HERE](http://knowtify.helpscoutdocs.com/article/20-can-i-upload-my-contacts-and-contacts-data-via-csv).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/oGKqB7mQLqr59RGsmFEI_skitch.png\",\n        \"skitch.png\",\n        \"1269\",\n        \"701\",\n        \"#f3356e\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nWhen you upload a CSV file, you will create a new contact for every email in the CSV. For existing contacts in the system, a new CSV upload will overwrite the data attached to that contact. \n\nBecause of this, using a simple CSV upload is a great way to get started using Knowtify without a technical integration. Some users like start using Knowtify by simply exporting data from their back-end systems in CSV (or JSON) format which they upload to Knowtify before sending any email.\n\n2 - **Create Zapier Zap**\n\nYou can also import data into Knowtify by setting a Zap in [Zapier](https://zapier.com/). With Zapier, you can set up a connection between any app in the Zapier marketplace and Knowtify. This means you can bring in data from various CRM tools, signup forms, Wordpress, etc. \n\nTo start using our Zapier hook, simply go to [this page](https://zapier.com/developer/invite/11858/6a871ac6db6a3c842922f4e73c4ae5bf/) and accept the invitation. \n\n3 - **Integrate your MixPanel account**\n\nIf you have data already integrated with Mixpanel, you can leverage that integration to bring data into Knowtify. If you are a MixPanel user and would like to use MixPanel to integrate with Knowtify, you can learn how [here](http://api.knowtify.io/v1.0/docs/mixpanel-integration).\n\n4 - **Use Segment.io**\n\nIf you have event data flowing through Segment.io, you can ship that data directly to Knowtify by 'turning on' the Knowtify integration in your Segment dashboard. You can learn more [here](http://api.knowtify.io/v1.0/docs/segmentio).\n\n5 - **[Install Knowtify JavaScript API](http://api.knowtify.io/v1.0/docs/javascript-widget)**\n\nA very quick and simple way to start shipping data to Knowtify. Simply drop some simple JavaScript into the front-end of your app and you can immediately start shipping data (and events) to your Knowtify account.\n\nLearn more about our JavaScript API [here](http://api.knowtify.io/v1.0/docs/javascript-widget).\n\n6 - **The Knowtify API**\n\nThe most robust way to integrate data with Knowtify is to ship it via our API. Our API is a simple JSON API using token authentication. A good way to get started with our API can be found [here](http://api.knowtify.io/v1.0/docs/knowtify-api-basics).","excerpt":"Welcome to Knowtify! Given that you've found your way here, we will assume that you have your Knowtify account all set up. If you don't, you should head over to our main site (http://knowtify.io) and sign up.","slug":"getting-started","type":"basic","title":"INTRODUCTION"}

INTRODUCTION

Welcome to Knowtify! Given that you've found your way here, we will assume that you have your Knowtify account all set up. If you don't, you should head over to our main site (http://knowtify.io) and sign up.

[block:api-header] { "type": "basic", "title": "Two types of Data in Knowtify" } [/block] There are two main categories data that you can bring into your Knowtify account - Contact-level Data and Global Data. **1. CONTACT-LEVEL DATA** This is the most common type of data that you will bring into Knowtify. This represents any attribute attached to a specific contact in your system. The only required attribute for a contact in Knowtify is an email address - you can't create a contact without an email address. But most commonly, contacts in Knowtify will have at least an email and name - as well as any piece of data associated with that contact that you will want to insert into your emails OR use to segment your emails. A typical contact record in Knowtify will look something like this; [block:image] { "images": [ { "caption": "", "image": [ "https://files.readme.io/GlYfred8SvmsvSnQ14PA_contact%20record.jpg", "contact record.jpg", "556", "595", "#e6e5e3", "" ] } ] } [/block] **2. GLOBAL DATA** Global Data, on the other hand, represents specific pieces of data that are NOT associated with a specific contact. This is data that may be relevant across your entire user base. For example, the typical blog or content site will store its blog posts (and related attributes like title, url, image, excerpt, etc) as Global Data points so they can be shared across all subscribers to its emails. Global Data can be accessed in the Data tab of your Knowtify account. [block:api-header] { "type": "basic", "title": "Ways to integrate data" } [/block] There are several ways to bring your data into Knowtify. They include: 1 - **Uploading via CSV or JSON files** The simplest way to bring data into your Knowtify is to upload a CSV of JSON file. You can do this right from the [People tab](http://www.knowtify.io/contacts). Learn more [HERE](http://knowtify.helpscoutdocs.com/article/20-can-i-upload-my-contacts-and-contacts-data-via-csv). [block:image] { "images": [ { "image": [ "https://files.readme.io/oGKqB7mQLqr59RGsmFEI_skitch.png", "skitch.png", "1269", "701", "#f3356e", "" ] } ] } [/block] When you upload a CSV file, you will create a new contact for every email in the CSV. For existing contacts in the system, a new CSV upload will overwrite the data attached to that contact. Because of this, using a simple CSV upload is a great way to get started using Knowtify without a technical integration. Some users like start using Knowtify by simply exporting data from their back-end systems in CSV (or JSON) format which they upload to Knowtify before sending any email. 2 - **Create Zapier Zap** You can also import data into Knowtify by setting a Zap in [Zapier](https://zapier.com/). With Zapier, you can set up a connection between any app in the Zapier marketplace and Knowtify. This means you can bring in data from various CRM tools, signup forms, Wordpress, etc. To start using our Zapier hook, simply go to [this page](https://zapier.com/developer/invite/11858/6a871ac6db6a3c842922f4e73c4ae5bf/) and accept the invitation. 3 - **Integrate your MixPanel account** If you have data already integrated with Mixpanel, you can leverage that integration to bring data into Knowtify. If you are a MixPanel user and would like to use MixPanel to integrate with Knowtify, you can learn how [here](http://api.knowtify.io/v1.0/docs/mixpanel-integration). 4 - **Use Segment.io** If you have event data flowing through Segment.io, you can ship that data directly to Knowtify by 'turning on' the Knowtify integration in your Segment dashboard. You can learn more [here](http://api.knowtify.io/v1.0/docs/segmentio). 5 - **[Install Knowtify JavaScript API](http://api.knowtify.io/v1.0/docs/javascript-widget)** A very quick and simple way to start shipping data to Knowtify. Simply drop some simple JavaScript into the front-end of your app and you can immediately start shipping data (and events) to your Knowtify account. Learn more about our JavaScript API [here](http://api.knowtify.io/v1.0/docs/javascript-widget). 6 - **The Knowtify API** The most robust way to integrate data with Knowtify is to ship it via our API. Our API is a simple JSON API using token authentication. A good way to get started with our API can be found [here](http://api.knowtify.io/v1.0/docs/knowtify-api-basics).