---
title: "Shopmonkey"
description: "Connect Shopmonkey, obtain the required access and configure permitted actions."
url: "https://documentation.verbatik.com/integrations/shopmonkey/"
---

# Shopmonkey

Connect Shopmonkey, obtain the required access and configure permitted actions.

The API adapter is implemented. Validate your own account and authorized actions before routing production calls.

## Before you start

Connect the account belonging to this business and workspace. Vendor subscriptions, API limits and role permissions still apply.

**API:** Shopmonkey REST API v3

**Authentication:** Bearer account API key

## Get access and connect

1. An account admin opens Settings → Integration → API Keys and creates a key. Choose an expiration policy suitable for production.
2. Save the key in Verbatik; test /v3/auth/api_key/status.
3. Use the shop's actual customer and vehicle IDs. Create an appointment and/or repair order with the captured service problem.
4. API keys inherit the creating user's permissions. Confirm the shop plan's API entitlement and staff scheduling workflow before promising availability.

## Account requirements

- Shopmonkey account with API access
- Admin-created API key
- Customer/vehicle IDs for linked appointments and orders

## Permissions

- `Creating admin's permissions for customers, appointments and repair orders`

Grant the subset needed for the actions you enable. API scopes do not override the connected user’s record permissions or vendor validation rules.

## Connection fields

- `accessToken` — API key or authorized access token (required). Secret fields are saved as workspace credentials.

## Available actions

- `test_connection` — **Read**. Check API key
- `get_customer` — **Read**. Read a known customer and contact information.
- `create_customer` — **Write**. Create a customer record.
- `search_appointments` — **Read**. Read appointments overlapping a date range; this shows bookings, not a promise of free mechanic capacity.
- `create_appointment` — **Write**. Create a service appointment tied to customer, vehicle and repair order IDs when known.
- `create_order` — **Write**. Create an order with a captured problem description and known customer/vehicle IDs.


## Verify before going live

Run Test connection and one read action against a known permitted record. Then test each intended write in an authorized sandbox. Check the provider’s own record and the Verbatik receipt. Publish the agent after assigning its tools. If a write has an unknown outcome, reconcile it with the vendor before trying again.

## Vendor documentation

- [Setup and API documentation](https://shopmonkey.dev/overview)
- [Additional provider reference](https://shopmonkey.dev/resources/customer)
- [Additional provider reference](https://shopmonkey.dev/resources/appointment)
- [Additional provider reference](https://shopmonkey.dev/resources/order)