WorkMobile (Preview)
WorkMobile is an award-winning No Code toolkit that allows businesses to deploy end-to-end field based mobile solutions. Remote staff can digitally record essential business data and it allows office staff to manage in real-time. It allows you to create complex calculations, embed Photos, Video, Audio, Signatures, GPS Locations, Barcodes, Maps and Timestamps. It also has the feature of a JobDispatcher and Document Share function.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | WorkMobile Support |
| URL | https://helpcentre.esayworkmobile.co.uk/ |
| wmsupport@workmobileforms.com |
| Connector Metadata | |
|---|---|
| Publisher | eSAY Solutions Ltd |
| Website | https://www.workmobileforms.com/ |
| Privacy policy | https://www.esayworkmobile.co.uk/privacy.aspx |
| Categories | Business Management;Productivity |
WorkMobile is an innovative mobile solution designed to transform traditional paper-based data collection into a sophisticated, digital format. It allows businesses to create custom mobile forms for data capture, including text, photos, signatures, and GPS locations, directly from any mobile device. With WorkMobile, users can:
- Create Custom Forms: Easily design forms that fit the exact needs of your business, without any need for coding.
- Capture Diverse Data Types: Collect a wide range of data including text, numbers, barcodes, photographs, signatures, and more.
- Work Offline: Collect data even when offline, and sync once a connection is restored.
- Ensure Data Accuracy: Reduce human error and improve the quality of data collected in the field.
- Streamline Reporting: Automatically generate and share reports using the collected data, enhancing decision-making and client communication.
Integrating WorkMobile with Microsoft Power Automate opens up even more possibilities, automating workflows and connecting your data collection with hundreds of other services seamlessly.
Prerequisites
You need to have a valid WorkMobile account and a suitable Office subscription.
WorkMobile credentials may be obtained for signing up for a WorkMobile account here - WorkMobile.
How to get credentials
Once an account is activated you can create an API token using the following steps
- Click add a new portal user
- Enter a username and other details as required (we suggest PowerAutomateAPIUser or similar)
- Add an email address - this isn't validated - you may use PowerautomateAPIUser@yourdomain.com
- Dont forget to click the active toggle on the top right of the Login Edit panel
- Click Save
- From the list find the user you have just created and click to edit the user
- In the Security details section - you will find an API Token heading.
- Click Generate, fill in the Description box and click update. Press OK to confirm each step
- Click copy at the end of the API Token box.
Use API key in any of your connectors.
Known Issues and Limitations
- Currently the only available trigger is to recieve completed records. We will extend this functionality to allow actions to be triggered on any of the WorkMobile job status changes.
- Ultimately the range of actions and triggers will be extended to cover the full actions supported by the API. The full set of operations are here https://www.esayworkmobile.co.uk/webapi2/swagger/index.html. Any actions or triggers currently unspported by the connector can be accessed by the HTTP or HTTP Webhook connector in PoweAutomate. PLease contact support for more details
Common errors and remedies
We have no known error or remedies, but if you have any questions please take a look at our Help Centre or we would love to hear from you via our friendly support team wmsupport.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Allocate a Job |
Allocate the specified Job to the specified mobile user |
| Create a new mobile user |
Create a new mobile user |
| Create Job |
Create a WM Job and optionally allocate it by supplying mobile user details |
| Job Broadcast |
Allocate the specified Job to a user group using Job Broadcast |
| Retrieve a list of forms |
Retrieve a list of forms visible to the current login and user group |
| Retrieve a report in the specified format |
Retrieve a binary object of the executed report |
| Retrieve Mobile Users |
Retrieve the visible mobile users visible on the account |
| Unallocate the Job |
Remove the specified Job from the user. Set the job back to unallocated status |
| Update the attributes associated with the mobile user |
Update the attributes associated with the mobile user |
| User Groups |
Retrieve a list of available user groups |
Allocate a Job
Allocate the specified Job to the specified mobile user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
JobId
|
JobId | True | string |
Unique id of job |
|
MobileUserId
|
MobileUserId | True | string |
Unique id of mobile user |
Returns
- response
- string
Create a new mobile user
Create a new mobile user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
firstname
|
firstname | string |
firstname |
|
|
surname
|
surname | string |
surname |
|
|
username
|
username | string |
username |
|
|
password
|
password | string |
password |
|
|
email
|
string |
|
||
|
mobile
|
mobile | string |
mobile |
|
|
jobTitle
|
jobTitle | string |
jobTitle |
|
|
addressLine1
|
addressLine1 | string |
addressLine1 |
|
|
addressLine2
|
addressLine2 | string |
addressLine2 |
|
|
addressLine3
|
addressLine3 | string |
addressLine3 |
|
|
town
|
town | string |
town |
|
|
county
|
county | string |
county |
|
|
postCode
|
postCode | string |
postCode |
|
|
userGroupId
|
userGroupId | string |
userGroupId |
|
|
isActiveUser
|
isActiveUser | boolean |
isActiveUser |
|
|
isBackgroundUploadEnabled
|
isBackgroundUploadEnabled | boolean |
isBackgroundUploadEnabled |
|
|
diallingCode
|
diallingCode | string |
diallingCode |
|
|
superuser
|
superuser | boolean |
downloadunpublishedforms |
|
|
backgroundUploadInterval
|
backgroundUploadInterval | integer |
backgroundUploadInterval |
|
|
accountSecurityId
|
accountSecurityId | integer |
accountSecurityId |
Returns
- response
- integer
Create Job
Create a WM Job and optionally allocate it by supplying mobile user details
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Job Type Id
|
JobTypeId | True | integer |
The JobType To Use |
|
Estimated Start Date
|
EstimatedStart | True | string |
Estimated Start date and time of Job |
|
Description
|
Description | True | string |
Job Description |
|
Duration
|
Duration | True | integer |
Duration of job |
|
Priority
|
Priority | True | integer |
Job priority |
|
Id of user to allocate to
|
AllocatedMobileUserId | True | integer |
Id of the user to allocate to '0' is unallocated |
|
Id of user group to broadcast to
|
AllocatedUserGroupId | True | integer |
Id of user group to allocate to '0' is unalllocated |
|
Data
|
Data | True | string |
The formatted JSON that describes the job and conforms to its JSD |
|
Longitude
|
Location.Longitude | True | integer |
Longitude of the job location |
|
Latitude
|
Location.Latitude | True | integer |
Latitude of the job location |
|
Address
|
Location.Address | True | integer |
Textual description of the location |
|
Files
|
files | True | array |
optional set of files |
Returns
Unique Id of raised job
- JobId
- integer
Job Broadcast
Allocate the specified Job to a user group using Job Broadcast
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
JobId
|
JobId | True | string |
Unique id of job |
|
UserGroupId
|
UserGroupId | True | string |
Unique id of user group |
Returns
- response
- string
Retrieve a list of forms
Retrieve a list of forms visible to the current login and user group
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
UserFormId
|
UserFormId | integer |
UserFormId |
|
Name
|
Name | string |
Name |
|
Description
|
Description | string |
Description |
|
Live
|
Live | boolean |
Live |
|
MobileVisible
|
MobileVisible | boolean |
MobileVisible |
|
LocationAware
|
LocationAware | boolean |
LocationAware |
|
AutoUpload
|
AutoUpload | boolean |
AutoUpload |
|
SaveToDrafts
|
SaveToDrafts | string |
SaveToDrafts |
|
Subform
|
Subform | string |
Subform |
|
LastUpload
|
LastUpload | string |
LastUpload |
|
Created
|
Created | string |
Created |
|
CreatedBy
|
CreatedBy | string |
CreatedBy |
|
Updated
|
Updated | string |
Updated |
|
UpdatedBy
|
UpdatedBy | string |
UpdatedBy |
Retrieve a report in the specified format
Retrieve a binary object of the executed report
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form Id
|
Id | True | string |
Unique form identifier |
|
Report Id
|
ReportId | integer |
Unique report identifier |
|
|
Report Format
|
ReportFormat | True | string |
Format to return report |
|
Row Id
|
rowId | True | integer |
Unique row identifier |
Returns
- Output
- binary
Retrieve Mobile Users
Retrieve the visible mobile users visible on the account
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
MobileUserId
|
MobileUserId | integer |
MobileUserId |
|
Firstname
|
Firstname | string |
Firstname |
|
Surname
|
Surname | string |
Surname |
|
JobTitle
|
JobTitle | string |
JobTitle |
|
UserGroupId
|
UserGroupId | integer |
UserGroupId |
|
Created
|
Created | string |
Created |
|
CreatedBy
|
CreatedBy | string |
CreatedBy |
|
Modified
|
Modified | string |
Modified |
|
ModifiedBy
|
ModifiedBy | string |
ModifiedBy |
|
Username
|
Username | string |
Username |
|
UserActive
|
UserActive | boolean |
UserActive |
Unallocate the Job
Remove the specified Job from the user. Set the job back to unallocated status
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
JobId
|
JobId | True | string |
Unique id of job |
Returns
- response
- string
Update the attributes associated with the mobile user
Update the attributes associated with the mobile user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
firstname
|
firstname | string |
firstname |
|
|
surname
|
surname | string |
surname |
|
|
username
|
username | string |
username |
|
|
password
|
password | string |
password |
|
|
email
|
string |
|
||
|
mobile
|
mobile | string |
mobile |
|
|
jobTitle
|
jobTitle | string |
jobTitle |
|
|
addressLine1
|
addressLine1 | string |
addressLine1 |
|
|
addressLine2
|
addressLine2 | string |
addressLine2 |
|
|
addressLine3
|
addressLine3 | string |
addressLine3 |
|
|
town
|
town | string |
town |
|
|
county
|
county | string |
county |
|
|
postCode
|
postCode | string |
postCode |
|
|
userGroupId
|
userGroupId | string |
userGroupId |
|
|
isActiveUser
|
isActiveUser | boolean |
isActiveUser |
|
|
isBackgroundUploadEnabled
|
isBackgroundUploadEnabled | boolean |
isBackgroundUploadEnabled |
|
|
diallingCode
|
diallingCode | string |
diallingCode |
|
|
superuser
|
superuser | boolean |
downloadunpublishedforms |
|
|
backgroundUploadInterval
|
backgroundUploadInterval | integer |
backgroundUploadInterval |
|
|
accountSecurityId
|
accountSecurityId | integer |
accountSecurityId |
Returns
- response
- string
User Groups
Retrieve a list of available user groups
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
UserGroupId
|
UserGroupId | integer |
UserGroupId |
|
Created
|
Created | string |
Created |
|
CreatedBy
|
CreatedBy | string |
CreatedBy |
|
Modified
|
Modified | string |
Modified |
|
ModifiedBy
|
ModifiedBy | string |
ModifiedBy |
|
Name
|
Name | string |
Name |
|
DefaultGroup
|
DefaultGroup | boolean |
DefaultGroup |
|
MenuId
|
MenuId | string |
MenuId |
Triggers
| When data is submitted for a form |
Set up the webhook |
When data is submitted for a form
Set up the webhook
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form
|
userFormId | True | integer |
userFormId |
|
Include Sub-Form Data
|
includeSubFormData | True | boolean |
includeSubFormData |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
Id | integer |
Id |
|
OriginalId
|
OriginalId | integer |
OriginalId |
|
Created
|
Created | string |
Created |
|
CreatedBy
|
CreatedBy | string |
CreatedBy |
|
Uploaded
|
Uploaded | string |
Uploaded |
Definitions
string
This is the basic data type 'string'.
integer
This is the basic data type 'integer'.
binary
This is the basic data type 'binary'.