Requirements
Before you set up the credential, make sure you have an active SpotOn account and an API access token from your account settings ready.[3]
Get your SpotOn credentials
- API KeypasswordRequired
- Merchant IDtextRequired
SpotOn Merchant ID from the dashboard.
[1]
Connect SpotOn in WEXTL
- Log in to your WEXTL account, add the SpotOn node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your SpotOn account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
SpotOn node modules
The list below is a reference of every SpotOn node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each SpotOn node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Cash DepositsTrigger
Output fields[3]
| 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 |
Watch Labour ReportsTrigger
Output fields[3]
| 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 |
Watch OrdersTrigger
Output fields[3]
| 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 |
3other output fields
Watch Paid-in/out TransactionsTrigger
Output fields[3]
| 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 |
Watch Time Clock EntriesTrigger
Output fields[3]
| 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 |
Get a Job Position by IDAction
Get a LocationSearch
Input fields[3]
| Field | Type |
|---|---|
SpotOn Merchant IDRequired | text |
| SpotOn Merchant Group ID (Optional) | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Deleted | boolean |
| Fiscalendofdaytime | number |
| Location ID | text |
| Name | text |
| Organization ID | text |
| Processingendofdaytime | number |
| Spotonmerchantgroupidloyalty | text |
| Spotonmerchantid | text |
| Timezone | text |
Get a Location by IDAction
Get a Location Cash Deposit by IDAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Cash Deposit IDRequired | text |
| Updated At Start | date |
| Updated At End | date |
Output fields[3]
| 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 |
Get a Location Menu Item by IDAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu Item IDRequired | text |
| Report Category ID | text |
Output fields[3]
| 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 |
Get a Location Modifier by IDAction
Get a Location Modifier OptionAction
Get a Location Order Type by IDAction
Get a Location Report Category by IDAction
Get a Location Station by IDAction
Get a Location Surcharge by IDAction
Get a Location Team by IDAction
Get a Location Team's Historical Record by IDAction
Get a Location Time Clock Entry by IDAction
Input fields[3]
| 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 |
Output fields[3]
| 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 |
Get a Payment OptionAction
Get an Employee's Location by IDAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Employee IDRequired | text |
Output fields[3]
| 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 |
| 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 |
Get Cash Deposit RecordsSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
| Updated At Start | date |
| Updated At End | date |
| Limit | number |
Output fields[3]
| 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 |
Get Historical Location TeamsSearch
Get Labor ReportsSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
| Business Date | date |
| Start Date | date |
| End Date | date |
| Limit | number |
Output fields[3]
| 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 |
Get Location Discount by IDAction
Get Location DiscountsSearch
Get Location EmployeesSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
| Limit | number |
Output fields[3]
| 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 |
| 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 |
Get Location Job PositionsSearch
Get Location Menu ItemsSearch
Get Location MenusSearch
Get Location Modifier OptionsSearch
Get Location ModifiersSearch
Get Location Order TypesSearch
Get Location OrdersSearch
Input fields[3]
| 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 |
Output fields[3]
| 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 |
3other output fields
Get Location Paid-In-Out by IDAction
Input fields[3]
| 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 |
Output fields[3]
| 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 |
Get Location Paid-In-OutsSearch
Input fields[3]
| 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 |
Output fields[3]
| 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 |
Get Location Payment OptionsSearch
Get Location Report CategoriesSearch
Get Location StationsSearch
Get Location SurchargesSearch
Get Location Tax by IDAction
Get Location TaxesSearch
Get Location TeamsSearch
Get Location Time Clock EntriesSearch
Input fields[3]
| 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 |
Output fields[3]
| 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 |
Get Menu ContentAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu IDRequired | text |
Output fields[3]
| 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 |
Get Menu Entity GroupsSearch
Get Menu IDsAction
Get Menu Item ModifiersSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Menu IDRequired | text |
| Modifier IDs | array |
| Limit | number |
Output fields[3]
| 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 |
Get Menu ItemsSearch
Create a Propose OrderAction
Input fields[3]
| 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 |
| text | |
| Address 1 | text |
| Address 2 | text |
| City | text |
| Postal Code | text |
| State | text |
| Phone Number | text |
Create an Order SubmissionAction
Input fields[3]
| 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 |
| text | |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| Postal Code | text |
| State | text |
| Phone Number | text |
Templates
Look for SpotOn templates in the WEXTL template library.
Browse templates →Explore alternative apps
- BlueSnap[2]Global payment gateway for accepting cards, local payment methods, and managing subscriptions.
- CapiumCloud accounting and practice management platform for accountants, covering invoicing, expenses, payments, and client communications.
- CheckoutGlobal payment platform for accepting cards, wallets, and alternative payment methods.
- CoinbaseCryptocurrency exchange and payments platform for trading, transfers, and digital asset orders.
- BillogramDigital invoicing and billing platform that sends invoices and collects payments from customers.
References
- WEXTL® SpotOn Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for SpotOn.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12