{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8a1e2b3f-af2c-4fd7-8a50-02ca83f6db23","name":"Botpress Messaging API Integration","description":"This is a simple integration for sending messages to your bot via API and recieving responses.  \n  \nYou can use this to send messages or other information back and forth between your bot and any back-end application.\n\n## How it works\n\nYou configure a webhook url for catching responses from your bot. Your bot may receive several responses for a single incomming message scattered through time. Each webhook invocation sends a single message back to your service.  \n  \nThe body of a webhook response should look like this:\n\n``` typescript\ntype WebhookResponse = {\n  type : string, \n  payload : any, // contains the response text or metadata otherwise\n  conversationId: string, // use this to send the response to the write location\n  botpressUserId: string, // botpress user id for debugging \n  botpressMessageId: string, // botpress message id for debugging \n  botpressConversationId: string, // botpress conversation id for debugging\n}\n\n ```\n\n  \nYou use the API endpoint below to send messages. When sending messages to your bot, you provide a **conversationId** parameter that will be sent back to your webhook url, so that you may identify where to send your bot's responses.\n\n## **Getting started**\n\n1. Install this integration to your bot.\n    \n2. To authenticate your messages, include a Personal Access Token you can get 👉 [here ](https://app.botpress.cloud/profile/settings) 👈 .\n    \n3. In your bot's integration page, find the Botpress api integration.\n    \n4. Add your webhook url to the **externalWebhookUrl** configuration option. This will recieve responses.\n    \n5. On the same page, copy the provided Webhook URL, this will be the endpoint for creating messages.\n    \n6. Send your first message using the instructions below.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"20577045","team":3684379,"collectionId":"8a1e2b3f-af2c-4fd7-8a50-02ca83f6db23","publishedId":"2s9YsDjEqu","public":true,"publicUrl":"https://documenter-api.postman.tech/view/20577045/2s9YsDjEqu","privateUrl":"https://go.postman.co/documentation/20577045-8a1e2b3f-af2c-4fd7-8a50-02ca83f6db23","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5291ff"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Sending and receiving messages to your Botpress bot using an API."},{"name":"title","value":"Botpress Messages Integration API"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/4a068340-2c31-4a39-8108-1c1efba1ba53/NjM2MjQyNGE5NGE4NWMzMWU1MzM2YTdjX0xvZ28gKDEpLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"5291ff"}},{"name":"light","logo":"https://content.pstmn.io/4a068340-2c31-4a39-8108-1c1efba1ba53/NjM2MjQyNGE5NGE4NWMzMWU1MzM2YTdjX0xvZ28gKDEpLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5291ff"}}]}},"version":"8.11.6","publishDate":"2024-01-03T15:37:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Botpress Messages Integration API","description":"Sending and receiving messages to your Botpress bot using an API."},"logos":{"logoLight":"https://content.pstmn.io/4a068340-2c31-4a39-8108-1c1efba1ba53/NjM2MjQyNGE5NGE4NWMzMWU1MzM2YTdjX0xvZ28gKDEpLnBuZw==","logoDark":"https://content.pstmn.io/4a068340-2c31-4a39-8108-1c1efba1ba53/NjM2MjQyNGE5NGE4NWMzMWU1MzM2YTdjX0xvZ28gKDEpLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/30449df58200a9efd1bd1bb6c2ed14296d55c04d2f4d09ee597afb0117e29f9e","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9YsDjEqu"}