# Sherweb integration

{% hint style="info" %}
If you’re new to integrations in Rewst, read through our introductory integration documentation [here](https://docs.rewst.help/documentation/integrations).
{% endhint %}

## What does the Sherweb integration do? <a href="#what-does-the-superops-integration-do" id="what-does-the-superops-integration-do"></a>

Our Sherweb integration enables seamless management of customer information, product catalogs, subscriptions, and licenses directly within the Rewst platform. This integration streamlines operations and automates ordering processes, enhancing efficiency for MSPs.

## Integration use cases <a href="#integration-use-cases" id="integration-use-cases"></a>

* Automate synchronization of customer data between Sherweb and Rewst.
* Streamline product catalog updates to ensure accurate offerings.
* Automate subscription and license management to reduce manual tasks.
* Enhance billing processes by integrating Sherweb's billing capabilities with Rewst.

## **Integration prerequisites**

* An active Sherweb partner account with API access.
* API credentials: Client ID, Client Secret, and Subscription Key from Sherweb.
* Access to the Rewst platform with administrative privileges.

## Set up the Sherweb integration <a href="#set-up-the-superops-integration" id="set-up-the-superops-integration"></a>

### Set up steps in Sherweb <a href="#set-up-steps-in-superops" id="set-up-steps-in-superops"></a>

1. Log in to your Sherweb partner account.
2. Navigate to the **Security > APIs** to generate your API credentials.\ <br>

   <figure><img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2F8S2voAcTT26Q6YVWyvfe%2Fimage%20(17).png?alt=media&#x26;token=92ae7dcd-2047-4a1d-b092-ef222ed1fb32" alt=""><figcaption></figcaption></figure>
3. Click **Create** to set up a new API client.\ <br>

   <figure><img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FxgZBvQne9swfaMhmXIO7%2Fimage%20(18).png?alt=media&#x26;token=8cb95ec8-4e25-473d-946f-86fcef9981b3" alt=""><figcaption></figcaption></figure>
4. Copy the **Client ID** and **Client Secret**.
5. Copy and save your Subscription Key, available in the same section. You’ll need this information to continue set up in Rewst.\
   ![](https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FS62JEvLXp1gTDpHYTL10%2Fimage%20\(19\).png?alt=media\&token=45163a86-dc41-4942-87f5-9966710b6948)

   <br>

### Set up steps in Rewst

1. Log in to the Rewst platform.
2. Navigate to **Marketplace > Integrations** in the left side menu.
3. In the Integrations page, search for the **Sherweb** integration.\
   \
   ![](https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FfEqWr1pDGNu8qV33TNII%2FScreenshot%202025-03-04%20at%209.29.59%E2%80%AFAM.png?alt=media\&token=d34d48bf-9a71-417b-9f53-91430a59d8ca)
4. Click on the integration tile to launch the Configuration setup page.
5. Under **Configuration**:
   1. Optionally provide a short description of the intended use of the configuration.
   2. Check **Is Default** on.
6. Under **Parameters**:

   1. Paste the client ID copied from Sherweb into the **Client ID** field of the configuration form.
   2. Paste your client secret copied from Sherweb into the **Client Secret** field.
   3. Paste your subdomain copied from Sherweb into the **Subdomain** field.

   <figure><img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FxEYpnC2jHAwvBkaa4vFe%2FScreenshot%202025-03-04%20at%209.32.45%E2%80%AFAM.png?alt=media&#x26;token=970c4470-713b-4486-babd-9203232fd6f2" alt=""><figcaption></figcaption></figure>
7. Click **Save Configuration.**
8. Rewst will do a quick validation of your input. Once completed, you'll see a new section beneath the configuration form for[ organization mapping](https://docs.rewst.help/documentation/integrations#what-is-organization-mapping). Complete your mapping as desired.&#x20;

## Test the integration

1. Initiate a test action within Rewst that utilizes the Sherweb integration, such as fetching the customer catalog.
2. Verify that the data retrieved matches your Sherweb account information, confirming a successful integration.

{% hint style="success" %}
Got an idea for a new Integration? Rewst is constantly adding new integrations to our integrations page. Submit your idea or upvote existing ideas here in our [Canny feedback collector](https://rewst.canny.io/integrations).
{% endhint %}

## Crates related to the Sherweb integration

Explore the following Crates in the Rewst Crate Marketplace to maximize the power of your Sherweb integration.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Microsoft User Onboarding</strong><br><br>This automation streamlines the offboarding process for users within an organization allowing for time savings and increased efficiency.</td><td><a href="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2F4l0LJOlWFFr3rra7ZG2x%2FScreenshot%202025-11-13%20at%203.06.37%E2%80%AFPM.png?alt=media&#x26;token=70e3b548-b081-4ce7-8c62-87aa56f1ce41">Screenshot 2025-11-13 at 3.06.37 PM.png</a></td><td><a href="../../crates/existing-crate-documentation/microsoft-user-onboarding-crate-v2">microsoft-user-onboarding-crate-v2</a></td></tr><tr><td><strong>Microsoft User Offboarding</strong><br><br>This automated workflow streamlines the New User Onboarding process by guiding users through a form to collect necessary information.</td><td><a href="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2F6JzH7CVeAGjS6RDz2owe%2FScreenshot%202025-11-13%20at%203.06.23%E2%80%AFPM.png?alt=media&#x26;token=ec6e0e8f-4ae8-4c44-b3dc-21ca1f106342">Screenshot 2025-11-13 at 3.06.23 PM.png</a></td><td><a href="../../crates/existing-crate-documentation/microsoft-user-offboarding-crate">microsoft-user-offboarding-crate</a></td></tr><tr><td><strong>Sync Sherweb Customer Subscriptions to Gradient Synthesize</strong><br>Daily at 9AM UTC, synchronize products and usage counts from all active subscriptions in Sherweb to Gradient Synthesize</td><td><a href="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2Fi4yYSEEMhvkbVu42X0wF%2FScreenshot%202025-11-13%20at%203.07.43%E2%80%AFPM.png?alt=media&#x26;token=f12dc2cb-eeb8-4c26-83b3-cd4e526db05a">Screenshot 2025-11-13 at 3.07.43 PM.png</a></td><td></td></tr></tbody></table>

{% hint style="success" %}
Got an idea for a new Integration? Rewst is constantly adding new integrations to our integrations page. Submit your idea or upvote existing ideas[ here](https://rewst.canny.io/integrations).
{% endhint %}

## Sherweb actions and endpoints

{% hint style="info" %}
For more on how actions work in Rewst, check out our introductory actions documentation[ here](https://docs.rewst.help/documentation/workflows/actions-in-rewst).
{% endhint %}

Refer to Sherweb's[ API documentation](https://developers.sherweb.com/) for detailed information on available endpoints and their usage. Ensure that you have the necessary permissions and correct endpoint URLs as specified in Sherweb's API documentation when configuring these actions. To access some API endpoints, you may have to set your rebilling settings within the partner portal, or contact your account manager at Sherweb to have them enabled manually.<br>

| Action name                        | Description                                                                                                                                                        | Endpoint                                                                                                                                                                                                                                 |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Create Subscriptions Amendment     | Amend subscription quantities for one of your customers..                                                                                                          | POST <https://api.sherweb.com/service-provider/v1/billing/subscriptions/amendments?customerId={customerId}>                                                                                                                              |
| Get Customers                      | Get the list of all your customers.                                                                                                                                | GET <https://api.sherweb.com/service-provider/v1/customers>                                                                                                                                                                              |
| Get Payable Charges                | Get your payable charges data for a specific billing period. There are three types of charges that are included in the data returned: recurring, usage, and setup. | GET [https://api.sherweb.com/distributor/v1/billing/payable-charges\[?date\]](https://api.sherweb.com/distributor/v1/billing/payable-charges\[?date%5D)                                                                                  |
| Get Receivable Charges             | Get a customer's amount owed for a specific billing period.                                                                                                        | GET [https://api.sherweb.com/service-provider/v1/billing/receivable-charges?customerId={customerId}\[\&date\]](https://api.sherweb.com/service-provider/v1/billing/receivable-charges?customerId=%7BcustomerId%7D%5B\&date%5D)           |
| Get Subscriptions                  | Get the list of subscriptions for one of your customers.                                                                                                           | GET [https://api.sherweb.com/service-provider/v1/billing/subscriptions?customerId={customerId}](https://api.sherweb.com/service-provider/v1/billing/subscriptions?customerId=%7BcustomerId%7D)                                           |
| Get Subscriptions Amendment Status | Get the status of a subscriptions amendment.                                                                                                                       | GET [https://api.sherweb.com/service-provider/v1/billing/subscriptions/amendments/{subscriptionsAmendmentId}/status](https://api.sherweb.com/service-provider/v1/billing/subscriptions/amendments/%7BsubscriptionsAmendmentId%7D/status) |


---

# 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.rewst.help/documentation/integrations/integration-guides/sherweb-integration-setup.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.