![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669789146098-ixcqia12.png\")
<\/p>\n“External Request” can be found in the bot builder under the “Action” block in the dropdown list of actions.<\/p>\n
<\/p>\n
Examples of how to use the “External Request” in bots:<\/strong><\/p>\n “Subscriber chooses which Star Wars character they are”<\/em>: link<\/a>.<\/p>\n<\/li>\n<\/ol>\n Sending the request.<\/p>\n<\/li>\n Testing the request.<\/p>\n<\/li>\n Description of simple JSON Path and saving data from the response to a user field.<\/p>\n<\/li>\n Using the retrieved data in the bot.<\/p>\n<\/li>\n<\/ul>\n Integration with Google Sheets<\/em> to read data from a spreadsheet: link<\/a>.<\/p>\n<\/li>\n<\/ol>\n Setting up and preparing the Google account for integration.<\/p>\n<\/li>\n Sending and testing the request.<\/p>\n<\/li>\n Description of more complex JSON Path and saving data from the response to a user field.<\/p>\n<\/li>\n Using the retrieved data in the bot.<\/p>\n<\/li>\n<\/ul>\n Sending SMS via the SMS Aero service<\/em>: video link<\/a>.<\/p>\n<\/li>\n Random number generator<\/em>: link<\/a>.<\/p>\n<\/li>\n The “External Request” action allows you to:<\/p>\n Send requests to external services via their API. Available request types: Save data received in the response from the external service into the subscriber\u2019s user fields.<\/p>\n<\/li>\n Test the request and view the response in a modal window.<\/p>\n<\/li>\n If macros are used in the request, test values will be substituted during testing and can be changed before the test.<\/p>\n<\/li>\n<\/ul>\n All “External Request” settings are configured in a separate modal window opened via the editor.<\/p>\n In the dropdown “Request Type,” select the type of request (check the external API documentation).<\/p>\n In the “URL” field, enter the request endpoint (also from the API documentation).<\/p>\n Standard macros can be used in the URL. To insert macros:<\/p>\n Place Separate parameters with Example: This section configures headers for the request.<\/p>\n You can:<\/p>\n Add\/remove headers;<\/p>\n<\/li>\n This section describes the body of the request (usually JSON), as required by the external service.<\/p>\n Only required for request types other than GET<\/strong>.<\/p>\n<\/li>\n Standard macros can be used.<\/p>\n<\/li>\n On the right side, a preview with validation and formatting is shown.<\/p>\n<\/li>\n<\/ul>\n Response Section<\/strong><\/p>\n This section displays the response received from the external service when the request test is launched.<\/p>\n Response Mapping Section<\/strong><\/p>\n In this section, you can configure response mapping so that data returned in the response to a request is saved to specified subscriber user fields.<\/p>\n You can view the data and its structure once you begin testing the request, under the “Response” tab in the “Response Body” section: This guide<\/a> describes a scenario that includes request testing, mapping setup, and further use of the data in the bot.<\/p>\n To configure mapping:<\/p>\n Add a mapping rule by clicking the + Add Mapping button<\/strong>;<\/p>\n<\/li>\n \n IMPORTANT!<\/strong> After configuring and testing the request, be sure to click Save.<\/p>\n IMPORTANT!<\/strong> To ensure the external request settings are not lost, make sure to save the “Action” step where you added the external request.<\/p>\n Frequently Asked Questions<\/strong><\/p>\n Where can I get the Key for headers?<\/strong><\/p>\n This depends on the service and method you are integrating via the external request. The external service\u2019s setup documentation will specify what keys to use and where to insert them.<\/p>\n Examples of using External Request<\/strong><\/p>\n Automated issuance of personalized certificates.\n
\n
\n
\n
\n
General Description<\/h3>\n
\n
GET, POST, PUT, PATCH, DELETE<\/strong><\/p>\n<\/li>\n![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669790117759-rvt9n3ji.png\")
<\/p>\nRequest Type and URL<\/h3>\n
\n
?<\/code> after the main link;<\/p>\n<\/li>\n&<\/code>.<\/p>\n<\/li>\n<\/ul>\nlink.ru?utm_content=1&{%field%}<\/code><\/p>\nHeaders<\/h3>\n
\n
![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669790964079-r9qkhohd.png\")
\nImportant<\/strong>: For correct data mapping, you must set the Content-Type<\/code> header in both the request and the service’s response.
Allowed values: application\/json<\/code> and text\/html<\/code><\/p>\n![\"\"](\"https:\/\/help.bothelp.io\/wp-content\/uploads\/2024\/09\/screenshot-at-mar-21-11-23-20.png\")
<\/p>\nBody<\/h3>\n
\n
![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669791215601-4fvv1oli.png\")
<\/p>\n![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669801158875-b38bli9h.png\")
<\/p>\n\n
![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669801340702-xr4j2zjz.png\")
\nThe response (status, headers, and body) will appear on the right side.
\n![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669892829766-nw41o1lq.png\")
\nUse the “Response Mapping” tab to extract and save values from the response into user fields.<\/p>\n
\n![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669892944936-jrzbsee9.png\")
<\/p>\n\n
![](\"https:\/\/files.carrotquest.io\/knowledge-bases-images\/articles\/49290\/49290-1669802688955-apibb03s.png\")
<\/p>\n
\n