{"_id":"584f002b1318690f009c7b1f","parentDoc":null,"user":"55aa7d625d3abb0d0012f3da","project":"55aa7d973be8f60d00041d42","githubsync":"","version":{"_id":"55aa7d983be8f60d00041d45","__v":20,"project":"55aa7d973be8f60d00041d42","createdAt":"2015-07-18T16:23:52.273Z","releaseDate":"2015-07-18T16:23:52.273Z","categories":["55aa7d983be8f60d00041d46","55aacf4e3be8f60d00041d89","55aacfaae2bdcb0d00c7466e","55aacfb3e2bdcb0d00c7466f","55aacfca3be8f60d00041d8a","55b67da3f8105a2f00c351ab","55b7cae4aea7c8190058ba5b","55b9218afeef5135009b7db3","55c182616d7d2921006da013","5631407afa40240d007c8c60","56548b9c9c4c6d0d00aeda0c","572b9137ff3ba10e00b4abb4","572b9150ff3ba10e00b4abb5","581b83288ca41f0f007e4fb6","585065fa70cbe00f00835bb8","58641eba0355f31900380492","58861760b4816e19005c9941","58a316cb254c401b00a049ce","58ac80dbd5e1570f00d1c328","59f72b4991121a00104f036e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":3,"category":{"_id":"581b83288ca41f0f007e4fb6","project":"55aa7d973be8f60d00041d42","version":"55aa7d983be8f60d00041d45","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-03T18:34:16.595Z","from_sync":false,"order":6,"slug":"chatbots","title":"ChatBots"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-12T19:53:15.772Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"","language":"text"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"response\":\"Nice! You speak Latin!\",\n  \"stopNextMessage\": true,\n  \"ignoreLead\": false,\n  \"matches\" : [\n    {\n  \t\t\"type\": \"equals\",\n  \t\t\"value\": \"lorem ipsum dolor sit amet\"\n\t\t},\n    {\n  \t\t\"type\": \"regex\",\n  \t\t\"value\": \".*ipsum.*dol.*amet\"\n\t\t},\n  \t{\n  \t\t\"type\": \"contains\",\n  \t\t\"value\": \"ipsum dolor sit\"\n\t\t},\n\t\t{\n  \t\t\"type\": \"startswith\",\n  \t\t\"value\": \"lorem ipsum\"\n\t\t},\n    {\n  \t\t\"type\": \"endswith\",\n  \t\t\"value\": \"sit amet\"\n\t\t},\n    {\n  \t\t\"type\": \"phrase\",\n  \t\t\"value\": \"lorems ipsums doloris sitis ametos\"\n\t\t}    \n  ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58a352b42ae7ed0f00d372b9","ref":"","in":"path","required":false,"desc":"","default":"","type":"string","name":"id"}],"url":"/sites/:id/chatbot/triggers"},"isReference":false,"order":4,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"response\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Bot's answer to the message.\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type (default)\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"stopNextMessage\",\n    \"1-1\": \"boolean (true)\",\n    \"1-2\": \"Will only send the response to the trigger. The bot will continue the conversation as normal once the user sends another message.\",\n    \"2-0\": \"ignoreLead\",\n    \"2-1\": \"boolean (false)\",\n    \"2-2\": \"Marks the lead as spam.\",\n    \"3-0\": \"matchesList\",\n    \"3-1\": \"array_object\",\n    \"3-2\": \"List of matchers for the trigger. Defined in the json below.\",\n    \"4-0\": \"matches[i].type\",\n    \"4-1\": \"One of this strings:\\n\\n-phrase\\n-contains\\n-startswith\\n-endswith\\n-equals\",\n    \"4-2\": \"IMPORTANT: ALL match strategies are **case-insensitive**)\\n\\n**phrase**: Use some intelligence to match if root keywords in user message match with \\\"value\\\"\\n\\n**regex**: Match the regular expression in \\\"value\\\"\\n\\n**equals**: Matches if user message is exactly **equals** to \\\"value\\\"\\n\\n**contains**: Matches if user message **contains** \\\"value\\\"\\n\\n**startswith**:  Matches if user message **starts with** \\\"value\\\"\\n\\n**endswith**: Matches if user message **ends with** \\\"value\\\"\",\n    \"5-0\": \"matches[i].value\",\n    \"5-1\": \"string\",\n    \"5-2\": \"the string value you want to match.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"chatbots-triggers-get","type":"endpoint","title":"/sites/:id/chatbot/triggers"}

get/sites/:id/chatbot/triggers


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string

Result Format


Documentation

[block:parameters] { "data": { "0-0": "response", "0-1": "string", "0-2": "Bot's answer to the message.", "h-0": "Field", "h-1": "Type (default)", "h-2": "Description", "1-0": "stopNextMessage", "1-1": "boolean (true)", "1-2": "Will only send the response to the trigger. The bot will continue the conversation as normal once the user sends another message.", "2-0": "ignoreLead", "2-1": "boolean (false)", "2-2": "Marks the lead as spam.", "3-0": "matchesList", "3-1": "array_object", "3-2": "List of matchers for the trigger. Defined in the json below.", "4-0": "matches[i].type", "4-1": "One of this strings:\n\n-phrase\n-contains\n-startswith\n-endswith\n-equals", "4-2": "IMPORTANT: ALL match strategies are **case-insensitive**)\n\n**phrase**: Use some intelligence to match if root keywords in user message match with \"value\"\n\n**regex**: Match the regular expression in \"value\"\n\n**equals**: Matches if user message is exactly **equals** to \"value\"\n\n**contains**: Matches if user message **contains** \"value\"\n\n**startswith**: Matches if user message **starts with** \"value\"\n\n**endswith**: Matches if user message **ends with** \"value\"", "5-0": "matches[i].value", "5-1": "string", "5-2": "the string value you want to match." }, "cols": 3, "rows": 6 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}