REST API

  • 1 minute(s) read
Prev Next

With this action you can invoke an external API including information of the objects where the automation has been triggered.

For example, you can propagate a newly created thing to the management system.

This action requires specifying the following information.

Method

The request method to indicate the desired action to be performed for a given resource.

You can use one of the following methods: GET, POST, PUT, DELETE.

URL

The HTTPS endpoint URL where the API is to be invoked is published.

If you need to add query string parameters, pay attention to encode parameter values correctly.

For instance, if you need to pass an API Key like "123456abcd==", you should use the following syntax.

https://www.acme.com/api/event?apiKey=123456abcd%3D%3D

Within the URL you can use placeholders that are replaced according to the automation context.

Authentication

You can specify which authentication must be used.

  • No Auth: no authentication is required by the endpoint.

  • Basic Auth: requires specifying also a username and password.



  • Microsoft Azure Active Directory: based on the Key Vault configured within the Microsoft Azure Active Directory plugin.

Request Headers

The set of name and values pairs to be sent as request headers.

Within the header values you can use placeholders that are replaced according to the automation context.

Payload

The JSON payload to be sent in case of POST or PUT requests.

The JSON is a template, so you can use placeholders to generate a dynamic payload according to the automation context.

Inspecting requests

To check the correctness of requests, you can temporarily use an online service that records every incoming request.
For instance, you can use Request Catcher,  it is enough to specify a domain and use the proposed URL in your automation.