Sequence Section API Block FAQs

Basics & Overview

1. What is the Sequence Section API block in a chatbot used for?

The API block enables your chatbot to connect and interact with external services and websites. It is used to send requests to an API and receive data in return.

2. Why is the Sequence Section API block placed in the "sequence section"?

The API block is in the "sequence section" because it performs an action in the middle of a conversation flow. It allows the bot to get or send data from an external source before continuing the conversation.

3. What is the main benefit of using the Sequence Section API block?

The main benefit is that it makes your chatbot more powerful by connecting it to your business's data or third-party services, allowing it to perform advanced tasks like checking order status, getting weather information, or looking up customer details.

4. How do I tell the bot what website or service to connect to using the Sequence Section API block?

You use the "URL" field to enter the web address of the API you want your bot to connect with.

Request Configuration

5. How do I choose the type of API request for my bot using the Sequence Section API block?

You select the type of request in the "Method" field. Common options include GET (to retrieve data), POST (to send new data), PUT (to update data), and DELETE (to remove data).

6. What is the purpose of the "Content Type" field in the Sequence Section API block?

The "Content Type" field tells the API what format the data is in. You can choose between common formats like JSON and XML.

Authentication

7. How can I securely connect to a private API using the Sequence Section API block?

You can connect securely by choosing an option from the "Generic Auth Type" field. The three main authentication types are Basic Auth, Bearer Auth, and Header Auth.

8. How do I set up "Basic Auth" for the Sequence Section API block?

If you select "Basic Auth," two fields will appear where you must enter a "Username" and a "Password."

9. How do I set up "Bearer Auth" for the Sequence Section API block?

If you select "Bearer Auth," a field will appear where you must enter a security "Token."

10. How do I set up "Header Auth" for the Sequence Section API block?

If you select "Header Auth," you will need to provide a "Name" and a "Value" for the custom header required by the API.

Parameters, Headers, & Body

11. How do I send extra information with my API request?

You can send extra information by using toggle buttons to enable or disable three main options: "Send Query Parameters," "Send Headers," and "Send Body."

12. What is the purpose of "Query Parameters" when using the Sequence Section API block?

You use query parameters to filter or sort the data you are requesting. When you enable the "Send Query Parameters" option, you can define them by entering a Key and a corresponding Value.

13. What is the purpose of "Headers" in an API request?

Headers are used to provide custom information in your request, such as an authentication key or specific content type. When you enable "Send Headers," you can add them by providing a Key and a Value.

14. When should I use "Send Body," and what does it do in the Sequence Section API block?

You should enable "Send Body" when you are using a request method like POST or PUT, as these methods require you to send data to the API. When you enable this option, a Body field will appear where you can enter the data you need to send.

Handling the Response & Variables

15. How can I save data that the API sends back to my bot?

You can save data from the API's response by enabling the "Save in variables" option.

16. How do I tell the bot what specific data to save from an API response?

In the "Save in variables" section, you can select the specific piece of data from the API response in the "Data field box."

17. How do I choose where to store the data received from an API?

After selecting the data field, you choose a variable to store it in by using the "Set Variable field box."

18. What is the final step to configure and save the Sequence Section API block?

After you have filled in all the fields, configured the request, and set up your variables, you must click submit to save the block.

Location & Tutorials

19. Where can I find the Sequence Section API block in the chatbot builder?

You can find the API block by navigating to Dashboard → Quick Access. Then, under ChatMaxima Studio, click on Create Chatbot. The API block will be available in the sequence section of the builder.

20. Where can I find a video tutorial for the Sequence Section API block?

To find a video tutorial for the API block, navigate to Dashboard → Resources. In the dropdown menu, click on Video Tutorial, and then use the search bar to find the specific guide.
Link:  https://chatmaxima.com/video-tutorials/creating-a-sequence-api-node-in-chatmaxima/