{"componentChunkName":"component---src-templates-docs-js","path":"/whatsapp/messaging/with_template/flows","result":{"data":{"site":{"siteMetadata":{"title":"broadcaster","docsLocation":"https://github.com","docsLocationType":"github","editable":false}},"mdx":{"fields":{"id":"a9bf47d2-59c4-5840-ac4f-6545e985459b","title":"WhatsApp Flows","slug":"/whatsapp/messaging/with_template/flows"},"body":"function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"WhatsApp Flows\",\n  \"order\": 4\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"blockquote\", null, mdx(\"p\", {\n    parentName: \"blockquote\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Integration summary\")), mdx(\"ul\", {\n    parentName: \"blockquote\"\n  }, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Endpoint:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging\")), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Token:\"), \" messaging token, in the \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"Authorization: Bearer {{wa-msg-api-token}}\"), \" header (\", mdx(\"a\", {\n    href: \"/whatsapp/authentication_token\"\n  }, \"how to generate it\"), \")\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Common fields:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"from\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"to\"), \" (phone number or BSUID) and \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"type\"), \" (\", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http#h-commonfields\"\n  }, \"details\"), \")\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"strong\"\n  }, \"type\"), \" values on this page:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"\\\"template\\\"\")), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Response:\"), \" the same for every message (\", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http#h-response\"\n  }, \"see response\"), \")\"))), mdx(\"p\", null, \"Templates that open a WhatsApp Flow. All are sent with \", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http\"\n  }, \"POST /v1/messaging\"), \"; headers, common fields and the response are in \", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http\"\n  }, \"HTTP connection\"), \". The general template structure (template and components objects) is in \", mdx(\"a\", {\n    href: \"/whatsapp/messaging/with_template\"\n  }, \"Template messages\"), \".\"), mdx(\"section\", {\n    \"id\": \"whatsappflows\"\n  }, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"WhatsApp Flows\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Template that opens a \", mdx(\"a\", {\n    href: \"/whatsapp/administration/flows\"\n  }, \"WhatsApp Flow\"), \" from a button. In the parameter object, \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"type\"), \" must be \\\"action\\\".\")), mdx(\"section\", {\n    \"id\": \"whatsappflows--body\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Body\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Fields for \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"WhatsApp Flows\"), \":\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"type\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The value is \\\"action\\\".\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/messaging/with_template/flows#h-actionobject\"\n  }, \"action\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The action you want the user to take after reading the message.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"whatsappflows--body--actionobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Action object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"flow_token\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"A token generated by the business that serves as an identifier.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"flow_action_data\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Optional input data for the first screen of the Flow. If provided, it must be a non-empty object.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Map<String, Object>\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Optional\"))))), mdx(\"section\", {\n    \"id\": \"whatsappflows--example\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Example\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Complete \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"WhatsApp Flows\"), \" example (HTTP request and JSON body):\")), mdx(\"section\", {\n    \"id\": \"whatsappflows--example--httprequestwithbodyandbutton\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"HTTP request with body and button\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-bash\"\n  }, \"curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \\\\\\n-H 'Authorization: Bearer {{wa-msg-api-token}}' \\\\\\n-H 'Content-Type: application/json' \\\\\\n-d '{\\n    \\\"from\\\": \\\"5215500000001\\\",\\n    \\\"to\\\": \\\"5215500000002\\\",\\n    \\\"type\\\": \\\"template\\\",\\n    \\\"template\\\": {\\n        \\\"language\\\": \\\"en_US\\\",\\n        \\\"name\\\": \\\"FLOW_TEMPLATE\\\",\\n        \\\"components\\\": [\\n            {\\n                \\\"type\\\": \\\"body\\\", \\n                \\\"parameters\\\": [\\n                    {\\n                        \\\"text\\\": \\\"This is a flows as template demo\\\",\\n                        \\\"type\\\": \\\"text\\\"\\n                    }\\n                ]\\n            },\\n            {\\n                \\\"type\\\": \\\"button\\\",\\n                \\\"subtype\\\": \\\"flow\\\",\\n                \\\"index\\\": 0,\\n                \\\"parameters\\\": [\\n                    {\\n                        \\\"type\\\": \\\"action\\\",\\n                        \\\"action\\\": {\\n                            \\\"flow_token\\\":\\\"AQAAAAACS5FpgQ_cAAAAAD0QI3s.\\\",\\n                            \\\"flow_action_data\\\": {\\n                                \\\"product_name\\\": \\\"name\\\",\\n                                \\\"product_description\\\": \\\"description\\\",\\n                                \\\"product_price\\\": 100\\n                            }\\n                        }\\n                    }\\n                ]\\n            }\\n        ]\\n    }\\n}'\\n\"))), mdx(\"section\", {\n    \"id\": \"whatsappflows--example--bodywithtextheader\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Body with text header\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"from\\\": \\\"5215500000001\\\",\\n    \\\"to\\\": \\\"5215500000002\\\",\\n    \\\"type\\\": \\\"template\\\",\\n    \\\"template\\\": {\\n        \\\"language\\\": \\\"en_US\\\",\\n        \\\"name\\\": \\\"FLOW_TEMPLATE\\\",\\n        \\\"components\\\": [\\n            {\\n                \\\"type\\\": \\\"body\\\", \\n                \\\"parameters\\\": [\\n                    {\\n                        \\\"text\\\": \\\"This is a flows as template demo\\\",\\n                        \\\"type\\\": \\\"text\\\"\\n                    }\\n                ]\\n            },\\n            {\\n                \\\"type\\\": \\\"button\\\",\\n                \\\"subtype\\\": \\\"flow\\\",\\n                \\\"index\\\": 0,\\n                \\\"parameters\\\": [\\n                    {\\n                        \\\"type\\\": \\\"action\\\",\\n                        \\\"action\\\": {\\n                            \\\"flow_token\\\":\\\"AQAAAAACS5FpgQ_cAAAAAD0QI3s.\\\",\\n                            \\\"flow_action_data\\\": {\\n                                \\\"product_name\\\": \\\"name\\\",\\n                                \\\"product_description\\\": \\\"description\\\",\\n                                \\\"product_price\\\": 100\\n                            }\\n                        }\\n                    }\\n                ]\\n            }\\n        ]\\n    }\\n}\\n\")), mdx(\"br\", null), mdx(\"hr\", {\n    parentName: \"section\"\n  })));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#whatsapp-flows","title":"WhatsApp Flows","items":[{"url":"#body","title":"Body","items":[{"url":"#action-object","title":"Action object"}]},{"url":"#example","title":"Example","items":[{"url":"#http-request-with-body-and-button","title":"HTTP request with body and button"},{"url":"#body-with-text-header","title":"Body with text header"}]}]}]},"timeToRead":1,"parent":{"__typename":"File","relativePath":"whatsapp/messaging/with_template/flows.md","fields":{"gitLogLatestAuthorName":"Irais Aguirre","gitLogLatestAuthorEmail":"irais.aguirre@conceptomovil.com","gitLogLatestDate":"6 hours ago"}},"frontmatter":{"metaTitle":null,"showMetadata":null,"editable":null,"showPreviousNext":null,"showToc":null}},"gitBranch":{"name":"20211019-2FACTOR_AUTH"},"gitCommit":{"hash":"9713e1925aeb8cad930f91b6bf05d0b5937b2bb5","date":"2026-11-13 06:39"}},"pageContext":{"id":"a9bf47d2-59c4-5840-ac4f-6545e985459b"}},"staticQueryHashes":["12478684","12478684","2882937274","2882937274","353167761","353167761"]}