# Web Service Connector

The WebService Connector allows you to consume REST web services.

Do this:

* import the web service from an OpenAPI definition file, *or*
* use the Connection Editor to create the connection manually.

***

{% embed url="<https://www.youtube.com/embed/fVHZwNR0UZc?autoplay=1&rel=0&vq=1080>" %}
Add a Web Service Connector
{% endembed %}

***

### Connection Editor Properties

To add a Connector, click on the Connector button located on the toolbar, then select the *Web Service* option.

To create the web service connection manually, click the Create Web Service Manually button and provide the following details:

![](/files/XHEkC4lrJ0WL7S8CzuCq)

1. **Base URL**

   This is the base URL of the web service.
2. **Timeout**

   This value corresponds to the duration in seconds before a request to the web service times out.
3. **Authentication**

Available options:

* *Anonymous*\
  \- For web services requiring no authentication.
* *Basic*\
  \- For web services requiring the HTTP basic method of authentication. Required: username and password.
* *Api Key*\
  \- For web services requiring authentication through an API key. Required: key name, key value and key location (QueryString/Header/Cookie).

5. *Note:* Stadium does not currently support authentication via OAuth2.

***

### Function Editor

To add a function, click on the relevant Connector's + sign:\
![](/files/cTryk1A4kKM7shOMrkcA)

A function placeholder is created.

<div align="left"><img src="/files/MAtnk1bNtX6qNPf84cJU" alt=""></div>

Click on the function name to open the *Function Editor*:

\\

<figure><img src="/files/aDjGScTjSAEdzvLmxA6r" alt=""><figcaption></figcaption></figure>

1. **Method**

   Use this dropdown to select the HTTP method type of the web request.
2. **Path**

   The URL segment specifying the path and query string parameters of a web request is specified here. Use "{ }" to denote any path parameter having variable values. For example, the path "/pet/{petId}/?filter=cat" will create the path parameter "petId". Path parameters will appear in the Parameters table.
3. **Parameters**

   The Parameters table lists the parameters available to be read or set in page controls or *Scripts*. To add a new parameter, enter the parameter name and location (QueryString/Header/Cookie) into the last row of the Parameters table.
4. **Body Format**

   Use this dropdown to select the body content type of the web request. This property is enabled only when the HTTP Method is set to POST or PUT.

***

### Function Properties

1. **Response Format**

   Use this dropdown to select the content type of the response received from the web request.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.stadium.software/connectors/web-service-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.