> For the complete documentation index, see [llms.txt](https://documentation.2pintsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.2pintsoftware.com/deployr/customization/custom-web-prompt.md).

# Custom web prompt

{% hint style="info" %}
Applies to: DeployR 1.4 and later.
{% endhint %}

The DeployR client can show a web page of your own before the task sequence starts, for example a form where the technician enters a computer name, picks a department, or chooses which task sequence to run. Whatever the page sends back becomes task sequence variables.

### Configuring the page

Set the `CustomWebUrl` variable to the URL of the page, usually in the `Variables` section of `Bootstrap.json`:

```json
{"Variables":{"DeployRHost":"https://deployr.contoso.com:7281","CustomWebUrl":"https://web.contoso.com/deployr/prompt.html?model=%ModelAlias%"}}
```

The URL can contain task sequence variables using `%VARIABLE%` syntax. They are replaced before the page loads, so the page can tailor itself to the device, for example by make or model.

The page is shown after the device is authenticated with the DeployR server and before the task sequence list. It is skipped when `CustomWebUrl` is blank, or when `TSID` is already set.

### Sending values back

When the user is done, the page posts its data to `deployr://submit`. DeployR closes the page and sets a task sequence variable for each value. There are two ways to send the data:

* **An HTML form.** Set the form's `action` to `deployr://submit` and its `method` to `post`. Each field becomes a variable named after the field.
* **A JSON object.** Use `fetch()` to post a JSON object. Each property becomes a variable. String values are used as they are; numbers, booleans, objects, and arrays are stored as their JSON text.

```html
<form action="deployr://submit" method="post">
  <label>Computer name <input name="ComputerName"></label>
  <label>Department
    <select name="Department">
      <option>Sales</option>
      <option>Engineering</option>
    </select>
  </label>
  <button type="submit">Continue</button>
</form>
```

```javascript
await fetch("deployr://submit", {
  method: "POST",
  body: JSON.stringify({ ComputerName: "PC-0042", Department: "Sales" })
});
```

Only the first successful submission counts. To pick the task sequence from the page as well, send a `TSID` value with the task sequence ID; DeployR then skips the task sequence list.

If the page cannot be loaded, details are written to `DeployR-UI.log`.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.2pintsoftware.com/deployr/customization/custom-web-prompt.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.