Wheels.Next Zapier Integration API Documentation

This document describes the Wheels.Next endpoints used by the Zapier integration. Zapier calls these endpoints to validate a user's API key, list event types, register or unregister Zapier webhook URLs, and fetch sample payloads for trigger setup. When a subscribed event occurs in Wheels.Next, Wheels.Next posts the event payload to the Zapier target_url stored during subscription.

This is not a general-purpose public API. These endpoints exist to support the Zapier integration lifecycle.

Base URL

Production base URL:

https://openapi.wheelsys.io/webhooks/zapier

All paths below are relative to this base URL. The API version is part of the route (v1).

Authentication

Every Zapier endpoint requires an API key in the X-Api-Key request header.

X-Api-Key: {api_key}

The API key must:

• belong to the tenant/user connecting the Zapier app;
• have the custom flag ZAPIER;
• have Solution API-key scope;
• resolve to a valid user id.

If the key is missing or invalid, the API returns 401 Unauthorized.

Common Headers

Zapier should send:

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Content-Type is only required for requests with a JSON body.

Endpoints

Validate Connection

Validates the user's Zapier API key and returns a display name for the Zapier connection.

POST /me

Request body: none.

Success response:

200 OK

{
  "ConnectionName": "tenant-host.example.com"
}

Error responses:

401 Unauthorized

List Event Types

Returns the event types that a Zap can subscribe to. This endpoint is intended for Zapier dynamic dropdown/input loading.

GET /events

Request body: none.

Success response:

200 OK

{
  "results": [
    {
      "id": 301,
      "label": "New Rental"
    },
    {
      "id": 307,
      "label": "Rental Updated"
    }
  ]
}

Response fields:

Error responses:

401 Unauthorized

Create Subscription

Registers or updates the Zapier REST Hook URL for the selected event type. Zapier calls this when a Zap is turned on.

POST /subscriptions

Request body:

{
  "target_url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
  "event_type": "301"
}

Request fields:

Success response:

200 OK

{
  "id": "sub_1001_45"
}

Response fields:

Notes:

• Subscriptions do not currently expire, so no expiration_date is returned.
• If a subscription already exists for the same event, Wheels.Next updates the stored target_url, marks the subscription active, and resets delivery counters.
• The endpoint stores one active delivery URL per event subscription record for the connected tenant.

Error responses:

401 Unauthorized

Invalid or non-numeric event_type values may result in a server-side validation/error response.

Remove Subscription

Deletes a previously registered Zapier REST Hook URL. Zapier calls this when a Zap is turned off.

DELETE /subscriptions/{id}

Path parameters:

Success response:

204 No Content

Notes:

• Unknown or malformed ids are treated as no-op unsubscribe requests and still return 204 No Content.
• The expected id format is sub_{tenantId}_{databaseId}.

Error responses:

401 Unauthorized

Get Sample Data

Returns sample trigger data for a selected event type. Zapier uses this during trigger setup/testing to discover fields.

GET /samples?event_type={event_id}

Query parameters:

Success response:

200 OK

[
  {
    "UID": "550e8400-e29b-41d4-a716-446655440000",
    "EventType": 301,
    "Timestamp": "2026-06-29T10:00:00Z",
    "Data": {
      "Id": 1234,
      "RentalNo": "R-000123",
      "Status": "Active"
    }
  }
]

Response fields:

Notes:

• The response is always an array.
• For delete events, Data contains at least the deleted entity id.
• If the selected event type is unknown, the endpoint returns fallback sample data containing Id and EventType.

Error responses:

401 Unauthorized

Missing or non-numeric event_type values may result in a server-side validation/error response.

Webhook Delivery

When a subscribed event occurs, Wheels.Next sends a JSON POST request to the Zapier target_url registered by POST /subscriptions.

Delivery request:

POST {target_url}
Content-Type: application/json

Payload:

{
  "UID": "550e8400-e29b-41d4-a716-446655440000",
  "EventType": 301,
  "Timestamp": "2026-06-29T10:00:00Z",
  "Data": {
    "Id": 1234,
    "RentalNo": "R-000123",
    "Status": "Active"
  }
}

Payload fields:

Delivery behavior:

• Wheels.Next posts JSON to each active subscription URL for the tenant and event type.
• A delivery succeeds when Zapier returns any 2xx HTTP status.
• Wheels.Next retries once after a 5-second delay when the first delivery attempt fails.
• Wheels.Next records delivery success/failure counts.
• Subscriptions are deactivated after 5 failed delivery attempts.

Available Event Types

The following event types are currently registered for Zapier.