1. Integrations

Deputy Integration Setup Guide

For the integration to work with the Deputy, it needs to use an access token connected to a system administrator account.

Creating an access token

A system administrator account can create an access token to use.

To create an access token, make sure you are logged in to Deputy as a system administrator, then go to https://(deputy_prefix).au.deputy.com/exec/devapp/oauth_clients and add a new token, where “(deputy_prefix)” is replaced with the correct prefix for your organisation’s Deputy website.

If you are already on your organisation’s Deputy website, it may be easier to paste just the end part (/exec/devapp/oauth_clients) onto the end of your browser’s URL, making sure you get rid of any path that might interfere.

For example:

  • Login to your site
  • https://site.au.deputy.com/home
  • https://site.au.deputy.com
  • https://site.au.deputy.com/exec/devapp/oauth_clients

Once you have reached the correct page, it’s time to create a new access token. To do this, you will need to enter the following information:

Name: Allara Integration
Redirect Uri: https://x.au.deputy.com/

Then click “Save This OAuth Client”.

deputy1

Once that is created, click “Get An Access Token” at the top of the page.

deputy2

deputy3

After the token has been created, make sure to copy the token ID and send it to Allara to add to the integration 

IMPORTANT: The access token will only be displayed in this popup box once. After pressing OK, it will never be shown again. Make sure it is copied or saved before closing the box.

Please copy and paste the token details, rather than taking a screenshot.

Along with the access token ID, please also provide Allara with your Deputy platform URL.