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

# Sherweb

> Connect Sherweb so agents can read subscriptions and prices, add or remove licence seats, and order a product a client does not hold yet

Neo connects to the [Sherweb Service Provider API](https://developers.sherweb.com/). With it connected, an agent can:

* Read customers, their configured platforms, subscriptions, charges and usage
* Look up a customer's catalogue, the price per billing cycle and commitment term, and the platform details an order needs
* Order a product a client does not hold yet, after a technician approves it
* Cancel a subscription, after a technician approves it
* Add or remove seats on an existing subscription with [Change License Seats](/agents/tools/m365/change-license-seats)

## Connect Sherweb

<Steps>
  <Step title="Collect your API credentials">
    In the [Sherweb Cumulus portal](https://cumulus.sherweb.com/), open **Security → APIs** and copy the **Client ID**, **Client Secret** and **Subscription Key**.
  </Step>

  <Step title="Save them in Neo">
    Open [**Integrations**](https://dashboard.neoagent.io/integrations?open=sherweb), select **Sherweb**, enter the three values, and click **Save**.
  </Step>

  <Step title="Map each company">
    On the [Companies](https://dashboard.neoagent.io/end-companies) page, open a company, add a **Sherweb** row under **Marketplace Company IDs** and pick the customer from the dropdown. Agents use this customer for orders and cancellations, and each approval request names it.
  </Step>
</Steps>

## What agents can do

Agents call Sherweb through the [Vendor API](/agents/tools/vendor-api) tool, which is added when you give the agent Sherweb permissions in its settings. Each permission group has its own access level:

| Permission group | What it covers |
| - | - |
| **Customers** | Sherweb customers, their configured platforms, configuring a platform before an order |
| **Products & Pricing** | A customer's catalogue, prices, billing cycles, commitment terms and platform requirements (read-only) |
| **Subscriptions** | Subscriptions, seat counts, prices, renewal dates, cancellation |
| **Orders** | Validating and placing orders, and following their progress |
| **Invoices & Usage** | Receivable charges, subscription meters and usage (read-only) |

The access profiles are **Read Only**, **Helpdesk** (every change asks a technician first) and **IT Admin** (no approval, except the two changes below). You can set approval per permission group.

<Warning>
  A new order and a subscription cancellation always ask a technician for approval, in every profile. Sherweb bills you for an order, and Microsoft does not let you reduce or cancel an annual commitment after its first days.
</Warning>

A configured platform's details can hold credentials. Before an agent or a script sees them, Neo replaces the value of each field whose name reads as a password, secret, token or key with `[redacted by Neo]`. The field stays in the answer.

## Buying a product a client does not hold

1. The agent finds the product in the client's catalogue. In Sherweb each SKU is one product on one billing cycle and commitment term.
2. It reads the price, and configures the platform the product needs when the client does not have it yet.
3. It validates the order with Sherweb, which places nothing.
4. It asks a technician to approve the order. The request names the product and SKU, the quantity, the billing cycle, the commitment term and the price.
5. After approval, it places the order with exactly those values and follows it until Sherweb reports success.
6. For a Microsoft product, once the licence shows in the client's Microsoft 365 tenant, the agent assigns it if it has the M365 Licensing permission; otherwise it uses your licensing tool, such as CIPP, or hands the step to a technician.

## Seat changes

To add or remove seats on a subscription the client already holds, the agent uses [Change License Seats](/agents/tools/m365/change-license-seats). The Vendor API tool refuses every subscription amendment. Change a billing term or commitment in Sherweb.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.