{"info":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","description":"

The Xeno API is a collection of HTTP RPC-style methods, all with URLs in the form https://xenoapp.com/rest/v2/METHOD_FAMILY/method.

\n

While it's not a REST API, those familiar with REST should be at home with its foundations in HTTP.

\n

Use HTTPS and SSL when calling all methods.

\n

Each method has a series of arguments informing the execution of your intentions.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1374550","collectionId":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","publishedId":"RW8CJ8dN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"27c469"},"publishDate":"2018-05-29T14:24:18.000Z"},"item":[{"name":"Widgets","item":[{"name":"/widgets","id":"8f1e507a-7e95-7799-5258-4266810f638e","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Jean Pierre 2","type":"text"}]},"url":"https://xeno.app/rest/v2/widgets/[api_key]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f1e507a-7e95-7799-5258-4266810f638e"},{"name":"/widgets/[api_key]","id":"3c7641de-73f6-38ab-f618-65415fc116c9","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Jean Pierre 2","type":"text"}]},"url":"https://xeno.app/rest/v2/widgets/[api_key]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c7641de-73f6-38ab-f618-65415fc116c9"},{"name":"/widgets","id":"b836e48c-c12b-f95a-33e3-683853baabed","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"A new widget\"\n}"},"url":"https://xeno.app/rest/v2/widgets","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b836e48c-c12b-f95a-33e3-683853baabed"},{"name":"/widgets/[api_key]","id":"7c17ef7d-f5ed-ff4a-b044-2b986d1f1de0","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"A new widget\"\n}"},"url":"https://xeno.app/rest/v2/widgets/[api_key]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c17ef7d-f5ed-ff4a-b044-2b986d1f1de0"},{"name":"/widgets/[api_key]","id":"d05beb9c-c201-42de-b63f-8d408615dfe1","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://xeno.app/rest/v2/widgets/[api_key]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"d05beb9c-c201-42de-b63f-8d408615dfe1"}],"id":"cb346996-dd89-308a-faf3-22058ee67cb9","_postman_id":"cb346996-dd89-308a-faf3-22058ee67cb9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"Contacts","item":[{"name":"/widgets/[api_key]/contacts","id":"b3f2bd96-4f8c-2908-b0c8-13463fec6ee8","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xenoapp.com/rest/v2/widgets/[api_key]/contacts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts"],"host":["xenoapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3f2bd96-4f8c-2908-b0c8-13463fec6ee8"},{"name":"/widgets/[api_key]/contacts/[id]","id":"271615e6-9c57-e393-b413-d996d54a7f8d","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"271615e6-9c57-e393-b413-d996d54a7f8d"},{"name":"/widgets/[api_key]/contacts/retrieve","id":"8552ad75-a46c-4135-cc86-cdcdf5a6e60b","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xenoapp.com/rest/v2/widgets/[api_key]/contacts/retrieve?cookie_token=COOKIE_TOKEN","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","retrieve"],"host":["xenoapp","com"],"query":[{"key":"cookie_token","value":"COOKIE_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"8552ad75-a46c-4135-cc86-cdcdf5a6e60b"},{"name":"/widgets/[api_key]/webhooks","id":"76e1feeb-cf17-585c-371b-8f867c8f4f12","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"remi@xenoapp.com\"\n}"},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"76e1feeb-cf17-585c-371b-8f867c8f4f12"},{"name":"/widgets/[api_key]/contacts/[id]","id":"10e15297-0e67-5890-347e-472c9a650b0d","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"10e15297-0e67-5890-347e-472c9a650b0d"}],"id":"e9644e16-6753-f784-7d73-610f8ad6bf7a","_postman_id":"e9644e16-6753-f784-7d73-610f8ad6bf7a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"Conversations","item":[{"name":"/widgets/[api_key]/conversations","id":"5187d0bc-6001-43b0-b774-467f9ff3edd0","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:3000/rest/v2/widgets/ppk-66625e44-6d02-4868-ba4f-0aaea212a46f/conversations","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"path":["rest","v2","widgets","ppk-66625e44-6d02-4868-ba4f-0aaea212a46f","conversations"],"host":["http://localhost:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"5187d0bc-6001-43b0-b774-467f9ff3edd0"},{"name":"/widgets/[api_key]/contacts/[id]","id":"27fbcd52-af54-441a-a320-48b2e3f97a8e","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:3000/rest/v2/widgets/ppk-66625e44-6d02-4868-ba4f-0aaea212a46f/conversations/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"path":["rest","v2","widgets","ppk-66625e44-6d02-4868-ba4f-0aaea212a46f","conversations","[id]"],"host":["http://localhost:3000"],"query":[],"variable":[]}},"response":[],"_postman_id":"27fbcd52-af54-441a-a320-48b2e3f97a8e"},{"name":"/widgets/[api_key]/contacts/retrieve","id":"bac47249-a7dd-4286-889c-e1573f76dbae","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xenoapp.com/rest/v2/widgets/[api_key]/contacts/retrieve?cookie_token=COOKIE_TOKEN","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","retrieve"],"host":["xenoapp","com"],"query":[{"key":"cookie_token","value":"COOKIE_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"bac47249-a7dd-4286-889c-e1573f76dbae"},{"name":"/widgets/[api_key]/webhooks","id":"55958f53-51ff-41bf-9f8b-3386512a4116","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"remi@xenoapp.com\"\n}"},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"55958f53-51ff-41bf-9f8b-3386512a4116"},{"name":"/widgets/[api_key]/contacts/[id]","id":"329d61b4-5667-42a0-ae4a-068e1bbfe3b6","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"329d61b4-5667-42a0-ae4a-068e1bbfe3b6"}],"id":"40ef1ebb-68b6-4985-85c3-2c3f632d674a","_postman_id":"40ef1ebb-68b6-4985-85c3-2c3f632d674a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"Faq Categories","item":[{"name":"/faq_categories","id":"8f34005d-b7c4-db34-3b27-d359d487eee1","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"widgets\": [\"837981035c7c79831a3de0a99ea22efa\", \"aeba0fb47afc2d4629406446c4c16335\"]\n}"},"url":"https://xeno.app/rest/v2/faq_categories","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faq_categories"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f34005d-b7c4-db34-3b27-d359d487eee1"},{"name":"/faq_categories/[id]","id":"8c2d25b7-938e-1225-aaf0-a58ac155327c","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"widgets\": [\"837981035c7c79831a3de0a99ea22efa\", \"aeba0fb47afc2d4629406446c4c16335\"]\n}"},"url":"https://xeno.app/rest/v2/faq_categories/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faq_categories","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c2d25b7-938e-1225-aaf0-a58ac155327c"},{"name":"/faq_categories","id":"61440f28-62d7-12c1-966e-1c2f3f5d59f0","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"title\": \"New category\",\n\t\"description\": \"Awesome new category with articles\",\n\t\"parent\": 42\n}"},"url":"https://xeno.app/rest/v2/faq_categories","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faq_categories"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"61440f28-62d7-12c1-966e-1c2f3f5d59f0"},{"name":"/faq_categories/[id]","id":"94b5e29f-8c7c-1fb6-e1d9-59b6fa958dd1","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"title\": \"New category\",\n\t\"description\": \"Awesome new category with articles\",\n\t\"parent\": 42\n}"},"url":"https://xeno.app/rest/v2/faq_categories/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faq_categories","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"94b5e29f-8c7c-1fb6-e1d9-59b6fa958dd1"},{"name":"/faq_categories/[id]","id":"10a33734-5e8e-52ed-b37d-e4fe059c722f","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://xeno.app/rest/v2/faq_categories[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faq_categories[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"10a33734-5e8e-52ed-b37d-e4fe059c722f"}],"id":"ab3b351c-04cd-796f-5c1c-c2efa18325c4","_postman_id":"ab3b351c-04cd-796f-5c1c-c2efa18325c4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"Faqs","item":[{"name":"/faqs","id":"f4cbd9d5-c99d-943b-ff73-1e0c4c631945","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"widgets\": [\"837981035c7c79831a3de0a99ea22efa\", \"aeba0fb47afc2d4629406446c4c16335\"]\n}"},"url":"https://xeno.app/rest/v2/faqs","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faqs"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4cbd9d5-c99d-943b-ff73-1e0c4c631945"},{"name":"/faqs?faq_category_id=[id]","id":"e349176b-f5bd-a1fa-7f92-e7747fc18567","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"widgets\": [\"837981035c7c79831a3de0a99ea22efa\", \"aeba0fb47afc2d4629406446c4c16335\"]\n}"},"url":"https://xeno.app/rest/v2/faqs?faq_category_id=[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faqs"],"host":["xeno","app"],"query":[{"key":"faq_category_id","value":"[id]"}],"variable":[]}},"response":[],"_postman_id":"e349176b-f5bd-a1fa-7f92-e7747fc18567"},{"name":"/faqs/[id]","id":"7163748a-83de-3430-c46c-7a3464911248","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"widgets\": [\"837981035c7c79831a3de0a99ea22efa\", \"aeba0fb47afc2d4629406446c4c16335\"]\n}"},"url":"https://xeno.app/rest/v2/faqs/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faqs","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"7163748a-83de-3430-c46c-7a3464911248"},{"name":"/faqs","id":"7ca7b50f-e6da-75bc-d9f8-5ca7265fea2d","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"title\": \"New FAQ\",\n\t\"content\": \"

Awesome FAQ!

\",\n\t\"status\": \"published\",\n\t\"canned_response\": true,\n\t\"faq_category_id\": 42,\n\t\"widgets\": [\"api_key_1\", \"api_key_2\"]\n}"},"url":"https://xeno.app/rest/v2/faqs","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faqs"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ca7b50f-e6da-75bc-d9f8-5ca7265fea2d"},{"name":"/faqs/[id]","id":"b7d92d14-c2ca-a819-1f9b-dd183de962f2","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":"{\n\t\"title\": \"New FAQ\",\n\t\"content\": \"

Awesome FAQ!

\",\n\t\"status\": \"published\",\n\t\"canned_response\": true,\n\t\"faq_category_id\": 42,\n\t\"widgets\": [\"api_key_1\", \"api_key_2\"]\n}"},"url":"https://xeno.app/rest/v2/faqs/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faqs","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7d92d14-c2ca-a819-1f9b-dd183de962f2"},{"name":"/faqs/[id]","id":"eec7f47b-8ea5-1a61-22e6-b4c481a6b6b7","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://xeno.app/rest/v2/faqs[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","faqs[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"eec7f47b-8ea5-1a61-22e6-b4c481a6b6b7"}],"id":"bd7eb43b-a515-aa6e-74e6-bab2f5dcc31a","_postman_id":"bd7eb43b-a515-aa6e-74e6-bab2f5dcc31a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"OAuth 2","item":[{"name":"Step 1","id":"3f4ea45e-5303-83ee-245e-a9263ed23f6d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"","type":"text"},{"key":"redirect_uri","value":"","type":"text"},{"key":"scope","value":"","type":"text"},{"key":"state","value":"","type":"text"}]},"url":"https://xenoapp.com/oauth/authorize","description":"

Your web or mobile app should redirect users to the following URL:

\n

https://xenoapp.com/oauth/authorize

\n

The following values should be passed as GET parameters:

\n
    \n
  • client_id - issued when you created your app (required)
    • \n
  • scope - permissions to request (see below) (required)
    • \n
  • redirect_uri - URL to redirect back to (see below) (optional)
    • \n
  • state - unique string to be passed back upon completion (optional)
    • \n
\n

The scope parameter is a space-separated list of OAuth scopes, indicating which parts of the user's account you'd like your app to be able to access. The complete list of scopes can be found here.

\n

The state parameter should be used to avoid forgery attacks by passing in a value that's unique to the user you're authenticating and checking it when auth completes.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["oauth","authorize"],"host":["xenoapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f4ea45e-5303-83ee-245e-a9263ed23f6d"},{"name":"Step 2","id":"6385d335-3856-e0bf-131f-9349c4985bcf","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"","type":"text"},{"key":"client_secret","value":"","type":"text"},{"key":"code","value":"","type":"text"},{"key":"redirect_uri","value":"","type":"text"}]},"url":"https://xenoapp.com/oauth/token","description":"

If all is well, exchange the authorization code for an access token using the oauth/token API method.

\n

https://xenoapp.com/oauth/token

\n
    \n
  • client_id - issued when you created your app (required)
    • \n
  • client_secret - issued when you created your app (required)
    • \n
  • code - a temporary authorization code (required)
    • \n
  • redirect_uri - must match the originally submitted URI (if one was sent)
    • \n
\n

You'll receive a JSON response containing an access_token (These access tokens are also known as bearer tokens):

\n
{\n  \"access_token\": \"ffb4acaf27c4028b858d91f7d7ff5b3fbe533d6a1b7d2281a89025d650aa6dff\",\n  \"scope\": \"widget\"\n}\n
\n

You can then use this token to call API methods on behalf of the user. The token will continue functioning until the installing user either revokes the token and/or uninstalls your application.

\n

Your app is considered \"installed\" as long as one of these tokens is still valid.

\n
\n

Please note that these access tokens do not expire.

\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["oauth","token"],"host":["xenoapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6385d335-3856-e0bf-131f-9349c4985bcf"}],"id":"58553daf-6ac4-9e7c-b3de-a3221dc232b8","description":"

OAuth 2.0 is a protocol that lets your app request authorization to private details in a user's account without getting their password. It's also the vehicle by which apps are installed on a account.

\n

Your app asks for specific permission scopes and is \nrewarded with access tokens upon a user's approval.

\n

You'll need to register your app before getting started. A registered app is assigned a unique Client ID and Client Secret which will be used in the OAuth flow. The Client Secret should not be shared.

\n","_postman_id":"58553daf-6ac4-9e7c-b3de-a3221dc232b8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"/widgets/[api_key]/webhooks","id":"fd2aede2-78ff-d73a-8ad9-4a1a1dbde441","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://xeno.app/rest/v2/widgets/API_KEY/webhooks/ID","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","API_KEY","webhooks","ID"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd2aede2-78ff-d73a-8ad9-4a1a1dbde441"},{"name":"/widgets/[api_key]/webhooks/[id]","id":"65cb06e0-8574-f4af-fae3-16a82b538257","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://xeno.app/rest/v2/widgets/API_KEY/webhooks","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","API_KEY","webhooks"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"65cb06e0-8574-f4af-fae3-16a82b538257"},{"name":"/widgets/[api_key]/webhooks","id":"624d8792-1489-cb9d-8a91-7e15c0a0c9c8","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"event\": \"message_created\", \"url\": \"https://surf-pruner.glitch.me/webhook\" }"},"url":"https://xeno.app/rest/v2/widgets/API_KEY/webhooks","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","API_KEY","webhooks"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"624d8792-1489-cb9d-8a91-7e15c0a0c9c8"},{"name":"/widgets/[api_key]/webhooks/[id]","id":"2ec901d6-748b-3cff-e70d-677e69246966","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"event\": \"message_created\",\n\t\"url\": \"https://surf-pruner.glitch.me/webhook\"\n}"},"url":"https://xeno.app/rest/v2/widgets/API_KEY/webhooks/ID","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","API_KEY","webhooks","ID"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ec901d6-748b-3cff-e70d-677e69246966"},{"name":"/widgets/[api_key]/webhooks/[id]","id":"64f59a39-1435-3ea2-4ce4-75f2a3698aa4","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://xeno.app/rest/v2/widgets/API_KEY/webhooks/ID","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","API_KEY","webhooks","ID"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"64f59a39-1435-3ea2-4ce4-75f2a3698aa4"}],"id":"823f813e-077a-ccf9-524e-48c2f73cd74d","description":"

You can register webhook URLs for Xeno to notify any time an event happens in your account. When the event occurs (a contact starts a conversation, a knowledge base entry is created, etc.) Xeno creates an Event object.

\n

This Event object contains all the relevant information about what just happened, including the type of event and the data associated with that event. Xeno then sends the Event object, via an HTTPS POST request, to any endpoint URLs that you have subscribed to. You can have Xeno send the same Event to multiple webhook endpoints.

\n

Quickstart:

\n

Step 1: Set up an example endpoint with Glitch

\n

↓ Click \"Remix This\" below to create a copy of the Glitch app.

\n

\"remix

\n

Step 2: Create the webhook subscription via the API

\n

According to our POST /widgets/[api_key]/webhooks request (documented here):

\n
{\n    \"event\": \"conversation_created\",\n    \"url\": \"https://<glitch-app-name>.glitch.me/webhook\"\n}\n

Step 3: Configure webhook settings

\n

Paste the webhook token you received via the API in your Glitch project .env file (variable: WEBHOOK_SECRET_TOKEN)

\n

Step 4: Send a test webhook event

\n

Create a new conversation on your chatbox, you should be able to see the event in your Glitch logs!

\n

Last step: Go live!

\n","_postman_id":"823f813e-077a-ccf9-524e-48c2f73cd74d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"Events","item":[],"id":"0637894b-b9af-e45a-33dc-3e8ac91451c7","_postman_id":"0637894b-b9af-e45a-33dc-3e8ac91451c7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}}},{"name":"/widgets/[api_key]/contacts/[contact_id]/events","id":"4192c969-8d81-b568-0277-8ac306fe6d24","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xenoapp.com/rest/v2/widgets/[api_key]/contacts/[contact_id]/events","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[contact_id]","events"],"host":["xenoapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4192c969-8d81-b568-0277-8ac306fe6d24"},{"name":"/widgets/[api_key]/contacts/[contact_id]/events/[id]","id":"43b617bf-9ac7-f825-038c-7be7391c2cd2","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer TOKEN"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[contact_id]/events/[id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[contact_id]","events","[id"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"43b617bf-9ac7-f825-038c-7be7391c2cd2"},{"name":"/widgets/[api_key]/contacts/[contact_id]/events/[id]","id":"6cbad950-50e7-f5e4-364f-68086d0cd1d3","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"kind\": \"pageview\"\n\t\"content\": \"https://google.com\"\n}"},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[contact_id]/events/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[contact_id]","events","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cbad950-50e7-f5e4-364f-68086d0cd1d3"},{"name":"/widgets/[api_key]/contacts/[contact_id]/events/[id]","id":"efeaac5d-7841-9e82-852e-7e68e3558bcd","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://xeno.app/rest/v2/widgets/[api_key]/contacts/[contact_id]/events/[id]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","id":"8e401d8b-fdaa-4ddc-c1e6-509e29f7dfcb","name":"Xeno API","type":"collection"}},"urlObject":{"protocol":"https","path":["rest","v2","widgets","[api_key]","contacts","[contact_id]","events","[id]"],"host":["xeno","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"efeaac5d-7841-9e82-852e-7e68e3558bcd"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"39cf448a-8fa6-443e-bf63-02dd3c11bb8c","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7de9a2c7-4945-4b95-9411-3d7a83287f6c","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"API_KEY","value":"ppk-66625e44-6d02-4868-ba4f-0aaea212a46f","type":"string"},{"key":"HOST","value":"http://localhost:3000","type":"string"}]}