What to expect

CLOUDWORK|PRO will schedule a kick off call with our team and yours for introductions and to discuss your company’s API needs and use case.   

Once we’ve met with your team and understand your needs we’ll send you the API license agreement to be signed and returned. After receipt and review of the signed agreement we will grant your team access to the API.

Your team will get access to our sandbox API for the initial setup and testing. Once our Engineering team has reviewed your integration and confirmed there aren’t any issues we’ll enable your production API access.

What we expect

We expect you will have the appropriate resources who will stay engaged during the setup of your API with CLOUDWORK|PRO. 

We expect that your team has access to development resources that are capable of integrating with modern REST APIs. NOTE: If your team doesn’t have access to these resources we can discuss the available options with you.

Setting up the integration

CLOUDWORK|PRO’s Engineering team has created an easy to use SDK (Node.js) for setting up your integration. Your team will be sent a link to download the NPM package. Once you have access to the SDK you can utilize our API documentation to complete the integration. 

Once your integration is set up you’ll have access to setup Webhooks for bi-directional data transfer.

What’s included? 

• Building and managing work orders
  • Work order basics
  • Documents
  • Tasks
  • Schedule
  • Payment
  • Assigned tech
  • Status updates
  • Notes
• Building and managing sites
  • Name, address and ID
  • Site contacts
  • Site specific notes
  • Site specific documents
• Building and managing projects
  • Name and description
  • Work Types
  • Users
  • Project documents

What’s not included? 

• Assigning or routing jobs to technicians
• Template creation
• User creation
• Messaging with tech