Your First Add-on

Watch the quick-start video to see how to get started with your first add-on, or follow the steps below.

Quick-Start Video

Quick-Start Video how to get started with hello world add-onQuick-Start Video how to get started with hello world add-on

Create your Add-on

  1. Sign up for a ServiceM8 Developer account
  2. Login, complete the Account Setup process, then click the Developer item in the main menu.
  3. Create a new add-on and set its name to "Hello World"
539539

Configure your Add-on

758758
  1. Set the Add-on Type to Simple Function Add-on (NodeJS)
  2. Upload the example manifest.json, and remember to click the Save button
  3. Click the Edit Function button to view and edit the code for your Add-on. Paste in the Hello World example code.

Activate your Add-on

Your add-on won't be publicly visible unless you submit it to the Store for Approval and have it approved, but you can still activate it on your own account for development and testing.

  1. Go to Settings > ServiceM8 Addons. Your add-on should appear at the top of the list, in the Custom Addons section (if it doesn't appear, give it 30 seconds then refresh the page).
  2. Click your Add-on to view the details, then click the Connect button
252252

Test your Add-on

901901
  1. Go to the Dispatch Board or Job History and open a Job.
  2. You should see a new job action menu item 'Hello Action'
  3. Click the Hello action. You'll see a popup window, this will be populated with the results of your Lambda function.
535535

Iterate!

Modify your code by clicking the Edit Function button in your Add-on's settings. When you click Save your code will be instantly updated and you can see the results by opening a Job and clicking the Hello Action button again.

We can't wait to see all the cool and useful ideas that developers will come up with!


Did this page help you?