---
title: "REST API"
slug: "automation-rest-api"
updated: 2024-12-09T09:57:02Z
published: 2024-12-09T09:57:02Z
canonical: "learn.servitly.com/automation-rest-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://learn.servitly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API

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](https://www.w3schools.com/tags/ref_urlencode.ASP) parameter values correctly.

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

```plaintext
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.*

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(180).png)
- *Microsoft Azure Active Directory*: based on the Key Vault configured within the [*Microsoft Azure Active Directory* plugin](https://help.servitly.com/hc/en-us/articles/10827673441181).

## Request Headers

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

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(181).png)

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.

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(182).png)

The JSON is a template, so you can use [placeholders](/docs/automation-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](https://requestcatcher.com/), it is enough to specify a domain and use the proposed URL in your automation.