> For the complete documentation index, see [llms.txt](https://glyue.docs.sandboxbanking.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://glyue.docs.sandboxbanking.com/reference/web-service-endpoints.md).

# Web Service Endpoints

Integration Gateway supports building web services that execute integrations via user-defined URL paths and methods. These enables the construction of traditional RESTful web services as explained in the [Building a RESTful CRUD Web Service](/tutorials/building-a-restful-crud-web-service.md) guide.

{% hint style="warning" %}
Only URL paths starting with `/api/` or `/rest/` are currently supported.
{% endhint %}

## Create a Web Service Endpoint

To create a web service endpoint for an integration:

1. Navigate to the *Build* page using the navigation sidebar.
2. Right-click on the integration you want to create a webservice endpoint for. Click *Configure.*
3. Exapnd the *Webservice Endpoints* section, then click *+ Add Webservice Endpoint*
4. Fill the fields, then click *Save.*

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

## Using a Webservice Endpoint

The full URL for a webservice endpoint is `your.environment.name.sandboxbanking.com/prefix/path_name` where

* `prefix` is either `api` or `rest`
* `path_name` is the path name configured in the webservice endpoint, **not the pathname of the integration**

## Fields

<table><thead><tr><th width="179">Name</th><th width="323">Example Value (s)</th><th>Description</th></tr></thead><tbody><tr><td>Path</td><td>Example: <code>q2/apps</code></td><td>Specifies the endpoint's URL path following the initial <code>/api/</code> or <code>/rest/</code> root fragment.<br><br>Do not include a leading <code>/</code> .</td></tr><tr><td>Method</td><td><code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>PATCH</code>, <code>DELETE</code></td><td>Specifies the HTTP method used for calling the API.</td></tr><tr><td>Prefix</td><td><code>/api</code>, <code>/rest</code></td><td>Specifies the endpoint URL's root path fragment. All web service endpoints must start with either <code>/api/</code> or <code>/rest/</code>.</td></tr><tr><td>Description</td><td>Example: Retrieves applications from Q2 Gro online deposit opening system</td><td>Description of the web service endpoint.</td></tr><tr><td>Response content type</td><td><code>application/json</code>, <code>application/html</code>, <code>text/xml</code>, <code>text/html</code>, <code>application/soap+xml</code></td><td>Specifies the integration response type.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://glyue.docs.sandboxbanking.com/reference/web-service-endpoints.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.