Skip to content
Rentshelf Docs
Install free on Shopify

Rentshelf API and booking webhooks

The API lets your own server read and change rental data: bookings, products, availability, blackouts, locations and quotes. Signed webhooks send booking events to a URL you choose. The full endpoint reference, with request examples, is at rentshelf.app/api/v1/docs.

This page is about Rentshelf’s own API. For the Shopify webhooks Rentshelf receives, see Webhooks & data.

Create an API key

Section titled “Create an API key”
  1. Open Settings → API access.
  2. Under API keys, enter a Key name, for example Warehouse sync.
  3. Choose Scopes: bookings:read, products:read, availability:read, locations:read, and the write scopes bookings:write, products:write, availability:write and webhooks:write. A write scope includes the matching read scope.
  4. Select Create API key and copy the key right away. Rentshelf stores only a hash, so the full key is shown once.

Use keys only on your server, never in theme or browser code. Write scopes change live data and there is no test mode: bookings created with a key can email customers and send payment requests.

Each key shows when it was created and last used, its requests today (UTC) and its last error. A store can have up to 25 active keys, and each key can make 60 requests per minute.

Add a webhook endpoint

Section titled “Add a webhook endpoint”
  1. Under Webhook endpoints, enter a public https:// Endpoint URL. Redirects are not followed.
  2. Choose the events: booking.created, booking.updated, booking.cancelled, booking.picked_up and booking.returned.
  3. Select Add endpoint, then use Show secret to copy the signing secret and Send test event to check your receiver.

Verify the Rentshelf-Signature header with the endpoint’s signing secret. Deliveries can arrive more than once and out of order, so deduplicate on the event ID. Failed deliveries are retried, and an endpoint is disabled after repeated failures; fix the receiver and select Enable. Each endpoint shows its delivery rate for the last 7 days, and Recent deliveries lists individual attempts. A store can have up to 10 endpoints.

Zapier, Make and other automation tools

Section titled “Zapier, Make and other automation tools”

Endpoints can also be created with the API (POST /webhook_endpoints), which is how REST-hook automation tools subscribe to booking events. The API reference describes the Zapier and Make connections and the scopes they need.

Shopify Flow

Section titled “Shopify Flow”

Shopify Flow triggers don’t need an API key. They come from your store’s Rentshelf installation: Rental booked, Rental status changed (any status change, including cancellations, with the previous status), Rental picked up, Rental returned and Rental overdue. Flow triggers are included in Growth.

Section titled “Related”