About this integration
Point-of-sale and restaurant management platform for orders, menus, labor, and location operations. This integration exposes its full API as workflow modules.
The integration includes 5 triggers, 44 search modules and 3 actions. Connections use basic authentication.
How to connect
The credential form asks for API Key and Merchant ID.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | — |
Merchant IDRequired | text | SpotOn Merchant ID from the dashboard. |
Use it in workflow automation
Start with Watch Cash Deposits, then add Create an Order Submission.
The canvas below runs Watch Cash Deposits into Create an Order Submission — watch the video, then drop a node onto the canvas.
Select the Watch Orders trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create an Order Submission as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 8 ready-made modules for finance work — each run logs its inputs and outputs for debugging.
SpotOn workflow on the canvas: Watch Orders then Create an Order Submission
Triggers, searches and actions
Browse every SpotOn module field below: 5 triggers, 44 searchs, and 3 actions you can drop onto the canvas.
Triggers
This integration includes 5 triggers — start a workflow the moment something changes in the app.
- Watch Cash Deposits
- Watch Labour Reports
- Watch Orders
- Watch Paid-in/out Transactions
- Watch Time Clock Entries
Searches
Use any of 44 search modules to retrieve records without leaving the workflow canvas.
- Get a Job Position by ID
- Get a Location
- Get a Location by ID
- Get a Location Cash Deposit by ID
- Get a Location Menu Item by ID
Actions
This integration includes 3 action modules — create, update, or delete records as part of any workflow.
- Create an Order Submission
- Create a Propose Order
- Make an API Call
Explore the fields available for each SpotOn trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Amount | number |
Deleted | boolean |
Employee ID | text |
Cash Deposit ID | text |
Job position ID | text |
Last updated by employee ID | text |
Last updated by job position ID | text |
Location ID | text |
Recorded at | number |
| Field | Type |
|---|---|
Business date key | text |
Declared cash tips amount | text |
Declared cash tips to others amount | text |
Employee full name | text |
Employee ID | text |
In at | date |
Job position ID | text |
Job position name | text |
Last updated at | date |
Location ID | text |
Out at | date |
Overtime pay amount | text |
Overtime pay rate amount | text |
Overtime seconds worked | number |
Regular pay amount | text |
Regular pay rate amount | text |
Regular seconds worked | number |
Time clock entry ID | text |
Total pay amount | text |
Unpaid break seconds | number |
| Field | Type |
|---|---|
Balance due amount | number |
Business date | text |
Checks | array |
Closed at | text |
Created at | text |
Created by employee ID | text |
Created by employee name | text |
Customer | object |
Phone | text |
Day part | text |
Deleted | boolean |
ID | text |
Location ID | text |
Name | text |
Order number | text |
Order type ID | text |
Order type name | text |
Owner info | object |
Employee ID | text |
Employee name | text |
Job position ID | text |
Released at | text |
Scheduled | boolean |
Table number | text |
| Field | Type |
|---|---|
Amount | number |
Business date | text |
Created at | text |
Credit card transaction | object |
Card holder name | text |
Card number | text |
Card type | text |
Day part | text |
Deleted | boolean |
Employee ID | text |
Employee name | text |
Location Paid In-Outs ID | text |
Kind | text |
Location ID | text |
Notes | text |
Payment name | text |
Payment option ID | text |
Reason | text |
Voided | boolean |
| Field | Type |
|---|---|
Breaks | array |
Declared cash tips amount | number |
Declared cash tips to others amount | number |
Deleted | boolean |
Employee ID | text |
ID | text |
In at | text |
Job position ID | text |
Last updated at | text |
Location ID | text |
Out at | text |
Pay rate amount | number |
Voided | boolean |
Searches
| Field | Type |
|---|---|
Location IDRequired | choice |
Job Position IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Job Position ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
SpotOn Merchant IDRequired | text |
SpotOn Merchant Group ID (Optional) | text |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Fiscalendofdaytime | number |
Location ID | text |
Name | text |
Organization ID | text |
Processingendofdaytime | number |
Spotonmerchantgroupidloyalty | text |
Spotonmerchantid | text |
Timezone | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
| Field | Type |
|---|---|
Deleted | boolean |
Fiscalendofdaytime | number |
Location ID | text |
Name | text |
Organization ID | text |
Processingendofdaytime | number |
Spotonmerchantgroupidloyalty | text |
Spotonmerchantid | text |
Timezone | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Cash Deposit IDRequired | text |
Updated At Start | date |
Updated At End | date |
| Field | Type |
|---|---|
Amount | number |
Deleted | boolean |
Employee ID | text |
Cash Deposit ID | text |
Job position ID | text |
Last updated by employee ID | date |
Last updated by job position ID | date |
Location ID | text |
Recorded at | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu Item IDRequired | text |
Report Category ID | text |
| Field | Type |
|---|---|
Additional ids | object |
Barcode | text |
Plu | text |
Reference | text |
Available | boolean |
Deleted | boolean |
Location Menu Item ID | text |
Location ID | text |
Name | text |
Open item | boolean |
Plu | text |
Report category ID | text |
Standard price amount | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
| Field | Type |
|---|---|
Deleted | boolean |
Location Modifier ID | text |
Location ID | text |
Name | text |
Report category ID | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Modifier Option IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Location Modifier Option ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Order Type IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Order Type ID | text |
Location ID | text |
Name | text |
Wtm ID | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Report Category IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Location Report Category ID | text |
Location ID | text |
Name | text |
Parent ID | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Station IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Location Station ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Surcharge IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Location Surcharges ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Team IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Employees | array |
ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Team IDRequired | text |
| Field | Type |
|---|---|
Break down method | number |
Eod ID | text |
Eod run at | number |
Eod run by | text |
Team ID | text |
Team members | array |
Team name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Time Clock Entry IDRequired | text |
Updated At Start | date |
Updated At End | date |
In Start | date |
In End | date |
Out Start | date |
Out End | date |
| Field | Type |
|---|---|
Breaks | array |
Declared cash tips amount | number |
Declared cash tips to others amount | number |
Deleted | boolean |
Employee ID | text |
ID | text |
In at | text |
Job position ID | text |
Last updated at | text |
Location ID | text |
Out at | text |
Pay rate amount | number |
Voided | boolean |
| Field | Type |
|---|---|
Location IDRequired | choice |
Employee IDRequired | text |
| Field | Type |
|---|---|
Active | boolean |
Additional ids | object |
Additional prop | text |
Address | object |
City | text |
Phone | text |
State | text |
Street 1 | text |
Street 2 | text |
Zip | text |
Birth date | text |
Deleted | boolean |
Email | text |
Exclude from reporting | boolean |
First name | text |
Hire date | text |
ID | text |
Job positions | array |
Last name | text |
Location ID | text |
Login code | text |
Nick name | text |
Payroll ID | text |
Pos user ID | text |
Termination date | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Payment Option IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Location Payment Option ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Updated At Start | date |
Updated At End | date |
Limit | number |
| Field | Type |
|---|---|
Amount | number |
Deleted | boolean |
Employee ID | text |
Cash Deposit ID | text |
Job position ID | text |
Last updated by employee ID | text |
Last updated by job position ID | text |
Location ID | text |
Recorded at | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Break down method | number |
Eod ID | text |
Eod run at | number |
Eod run by | text |
Team ID | text |
Team members | array |
Team name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Business Date | date |
Start Date | date |
End Date | date |
Limit | number |
| Field | Type |
|---|---|
Business date key | date |
Declared cash tips amount | text |
Declared cash tips to others amount | text |
Employee full name | text |
Employee ID | text |
In at | date |
Job position ID | text |
Job position name | text |
Last updated at | date |
Location ID | text |
Out at | date |
Overtime pay amount | text |
Overtime pay rate amount | text |
Overtime seconds worked | number |
Regular pay amount | text |
Regular pay rate amount | text |
Regular seconds worked | number |
Time clock entry ID | text |
Total pay amount | text |
Unpaid break seconds | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Discount IDRequired | text |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Location Discount ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
ID | text |
Location Discount ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Active | boolean |
Additional ids | object |
Additional prop | text |
Address | object |
City | text |
Phone | text |
State | text |
Street 1 | text |
Street 2 | text |
Zip | text |
Birth date | text |
Deleted | boolean |
Email | text |
Exclude from reporting | boolean |
First name | text |
Hire date | text |
ID | text |
Job positions | array |
Last name | text |
Location ID | text |
Login code | text |
Nick name | text |
Payroll ID | text |
Pos user ID | text |
Termination date | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Location Job Position ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Additional ids | object |
Barcode | text |
Plu | text |
Reference | text |
Available | boolean |
Deleted | boolean |
ID | text |
Location ID | text |
Name | text |
Open item | boolean |
Plu | text |
Report category ID | text |
Standard price amount | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Order Type ID | text |
Date From | date |
Date To | date |
Limit | number |
| Field | Type |
|---|---|
Menu ID | text |
Order type | object |
Order type ID | text |
Order type name | text |
Availability | object |
Daytimes | array |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Location Modifier Options ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Location Modifier ID | text |
Location ID | text |
Name | text |
Report category ID | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Created At Start | date |
Created At End | date |
Updated At Start | date |
Updated At End | date |
Closed At Start | date |
Closed At End | date |
Business Date | date |
Business Date Start | date |
Business Date End | date |
| Field | Type |
|---|---|
Balance due amount | number |
Business date | date |
Checks | array |
Closed at | date |
Created at | date |
Created by employee ID | text |
Created by employee name | text |
Customer | object |
Phone | text |
Day part | text |
Deleted | boolean |
ID | text |
Location ID | text |
Name | text |
Order number | text |
Order type ID | text |
Order type name | text |
Owner info | object |
Employee ID | text |
Employee name | text |
Job position ID | text |
Released at | date |
Scheduled | boolean |
Table number | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Location Order Type ID | text |
Location ID | text |
Name | text |
Wtm ID | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Paid-In-Out IDRequired | text |
Created At Start | date |
Created At End | date |
Business Date | date |
Business Date Start | date |
Business Date End | date |
| Field | Type |
|---|---|
Amount | number |
Business date | date |
Created at | date |
Credit card transaction | object |
Card holder name | text |
Card number | text |
Card type | text |
Day part | text |
Deleted | boolean |
Employee ID | text |
Employee name | text |
Location Paid In-outs ID | text |
Kind | text |
Location ID | text |
Notes | text |
Payment name | text |
Payment option ID | text |
Reason | text |
Voided | boolean |
| Field | Type |
|---|---|
Location IDRequired | choice |
Created At Start | date |
Created At End | date |
Business Date | date |
Business Date Start | date |
Business Date End | date |
Limit | number |
| Field | Type |
|---|---|
Amount | number |
Business date | date |
Created at | date |
Credit card transaction | object |
Card holder name | text |
Card number | text |
Card type | text |
Day part | text |
Deleted | boolean |
Employee ID | text |
Employee name | text |
Location Paid In-Outs ID | text |
Kind | text |
Location ID | text |
Notes | text |
Payment name | text |
Payment option ID | text |
Reason | text |
Voided | boolean |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Location Payment Option ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Location Report Category ID | text |
Location ID | text |
Name | text |
Parent ID | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Location Station ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Enabled | boolean |
Location Surcharges ID | text |
Location ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Tax IDRequired | text |
| Field | Type |
|---|---|
Default rate percentage | number |
Deleted | boolean |
Location Tax ID | text |
Location ID | text |
Name | text |
Rate overrides | array |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Default rate percentage | number |
Deleted | boolean |
Location Tax ID | text |
Location ID | text |
Name | text |
Rate overrides | array |
| Field | Type |
|---|---|
Location IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Deleted | boolean |
Employees | array |
ID | text |
Name | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Updated At Start | date |
Updated At End | date |
In Start | date |
In End | date |
Out Start | date |
Out End | date |
Limit | number |
| Field | Type |
|---|---|
Breaks | array |
Declared cash tips amount | number |
Declared cash tips to others amount | number |
Deleted | boolean |
Employee ID | text |
ID | text |
In at | text |
Job position ID | text |
Last updated at | date |
Location ID | text |
Out at | date |
Pay rate amount | number |
Voided | boolean |
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu IDRequired | text |
| Field | Type |
|---|---|
Menu item groups | object |
Additional prop | object |
Menu items | object |
Additional prop | object |
Sub item groups | object |
Additional prop | object |
Modifier groups | object |
Additional prop | object |
Modifiers | object |
Additional prop | object |
Modifier options | object |
Additional prop | object |
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu IDRequired | text |
Group IDs | array |
Limit | number |
| Field | Type |
|---|---|
Sub item groups | array |
Modifier groups | array |
| Field | Type |
|---|---|
Location IDRequired | text |
| Field | Type |
|---|---|
Menu ID | text |
Order type | object |
Order type ID | text |
Order type name | text |
Has content generated | boolean |
Expires in seconds | number |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu IDRequired | text |
Modifier IDs | array |
Limit | number |
| Field | Type |
|---|---|
Modifier ID | text |
Parent modifier group info ID | text |
Display name | text |
Available | boolean |
Out of stock | boolean |
Is default | boolean |
Modifier options | object |
Default modifier option key | text |
Modifier option keys | array |
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu IDRequired | text |
Item IDsRequired | array |
Limit | number |
| Field | Type |
|---|---|
Additional prop | object |
Menu item location ID | text |
Menu item ID | text |
Display name | text |
Description | text |
Available | boolean |
Out of stock | boolean |
Is alcohol | boolean |
Is sub item | boolean |
Image URL | text |
Additional info | object |
Actions
| Field | Type |
|---|---|
Location IDRequired | choice |
Order Type IDRequired | text |
Scheduled Date Time | date |
Menu ItemsRequired | array |
Menu Item Location IDRequired | text |
Menu Item IDRequired | text |
QuantityRequired | number |
Additional Info | object |
Modifier Groups | array |
Sub Item Group Info ID | text |
Sub Items | array |
Discount Codes | array |
CustomerRequired | object |
First NameRequired | text |
Last NameRequired | text |
Email | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
Postal Code | text |
State | text |
Phone Number | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Order Type IDRequired | text |
Scheduled DateTime | date |
Menu ItemsRequired | array |
Menu Item Location IDRequired | text |
Menu Item IDRequired | text |
QuantityRequired | number |
Additional Info | object |
Modifier Groups | array |
Sub Item Group Info ID | text |
Sub Items | array |
Discount Codes | array |
CustomerRequired | object |
First NameRequired | text |
Last NameRequired | text |
Email | text |
Address 1 | text |
Address 2 | text |
City | text |
Postal Code | text |
State | text |
Phone Number | text |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |

