Page History

...

This article is a guide on how to configure the REST API Call bot block. It will use the Monitoring [Opened Tickets Today - Template] for_test bot as an example.

What‘s on this page:

Prerequisites

...

1. A bot of the trigger type has been created.
2. A widget or dataset has been created to filter integration data according to your needs.
3. The API documentation for the corresponding integration has been found, and APIs that meet your requirements have been identified.

Required Permissions

...

To follow this guide, you need admin-level permissions to perform the operations.

To set up the bot block

...

1. Go to Bots on the MSPbots menu. 
   
2. Open the bot that where you want need to add the a REST API Call block to. 
   Image Removed. Let's use the bot Monitoring [Opened Tickets Today - Template] for_test as an example.
   Image Added
3. When the selected bot opens, go Go to the Design tab. If a another window opens, close it. 
   
4. In the trigger block, configure the widget or dataset that you have already created as a data source according to your needs. For detailed configuration information of the trigger block, please refer to 2. Set up the bot trigger.
   Image Added
   
5. Hover over the horizontal line between the blocks. Click , select Add a Block, and select the new block. 
   
6. Type REST API Call in the search bar and click REST API Call.
   
7. Next, hover over the ellipsis for the REST API Call block and select Edit.
   
8. When the REST API Call window opens, enter the url address of the API that will receive requests . you want to call, for example,https://mspbotstest.halopsa.com/api/Tickets.
   
9. (Optional) Select an integration.
   If you are configuring a REST API from an existing integration with MSPbots, select that software from the integration list, such as halo. Otherwise, please do not configure this parameter and proceed with the next step.
   
10. Select an appropriate HTTP method to use.the HTTP method used when calling the API. The commonly used methods when using this block are post and delete. If you want to learn examples of these two methods, please refer to Examples of commonly used HTTP Methods when using the REST API Call block.
    
    • get 
    • get - Retrieves information from the database without modifying or adding data. The results are consistent regardless of how many operations are performed.
    • post: Submits data and adds operations to the server.
    • put: Modifies the existing data on the server. This is similar to POST except that it modifies instead of adding.
    • delete: Removes a specific resource , like deleting and deletes a record in a database.
    • options: A pre-check request of Before using any of these methods, you can check the browser request to ensure the server accepts the request before sending get, post, put, or delete requestswill accept it.
      
11. Next, set up the headers and input
the relevant
12. the relevant key and value. Headers are additional information included in the API call, which may include authentication tokens and content types. 
    

    Info
    As our Bot already supports authentication information by default, you don't need to add any extra authentication information to REST API Call block.

    
    Image Modified
    Click Add to add more keys and values.
    Image Modified
    
    To remove a pair of key and value, click Delete. 
    
    
13. Set up the params. Select either the URL query and request body method to pass parameters to the server.
    
    1. query
       URL query parameters are a way of passing parameters through the URL. In the URL, query parameters usually start with a "?" symbol and are separated by "&" symbols.
       For example: https://www.example.com/path/to/resource?param1=value1&param2=value2refer to additional parameters or information passed to the server through key-value pairs attached to the URL. Query parameters are commonly used for filtering, sorting, pagination, or passing other optional parameters. They are placed after the question mark symbol (?) in the URL and key-value pairs are separated by an equals sign (=), while multiple query parameters are connected with an ampersand (&). By utilizing URL query parameters, we can pass additional parameters in the API call and customize the results requested.
       
    2. body
       The request body is an the HTTP request with data that is usually part of included in a POST or PUT request. It is only configured when the method is POST or PUT. This data can be in various different formats such as JSON, XML, or form data. These parameters are usually used for submitting forms, uploading files, or sending other types of data. 
       
       The params available for the request body method are none, form-data, x-www-form-urlencoded, JSON, and XML. 
       
14. Click Next to configure any remaining blocks, and click Finish when done.
15. Click Save to keep your settings.

Anchor
Examples Examples

Examples of commonly used HTTP Methods when using the REST API Call block

...

post - Create tickets to the Halo app with the filtered data that meets the criteria.

*For more detailed information, please refer to:How to Create or Modify Halo Tickets using a Rest API-based Bot.

Image Added

delete - Delete tickets in the Halo app that meet the filtering criteria.

Image Added

Related topics

...