Who is this article for?

Administrators responsible for setting up API integrations.

This article walks you through the process of enabling the Deputy (Rostering) integration in Ideagen Procedure Management. If you need any further assistance with this or need us to enable the integration, please submit a ticket to the Support team. 

1. Pre-requisite:

Ask the Ideagen Support team to enable Deputy (Rostering) integration for you and add the Rostering widget your Dashboard.

Once this is done, the integration will need to be setup. Until then, you will see this message:

2. Create the OAuth Client in the Deputy (Once) Portal

1. Go to the Deputy Once OAuth Portal: https://once.deputy.com/my/oauth_clients
2. Your will need to sign in with your Deputy account if not already. 
3. You will see this screen below:
   
4. Click New OAuth Client

5. Fill out the Name and Redirect Uri details

   i. Name (you choose)

   ii. Redirect Uri: 
   https://{client}.api.opcentral.com.au/roster/deputy/redirect

   Example: https://customersuccess.api.opcentral.com.au/roster/deputy/redirect

6. Click Save This Oath Client

   

   7. Copy the 'Client ID' and 'Client Secret' to Notepad. 

   Important: After saving, copy the Client ID and Client Secret immediately. The Client Secret is only shown once and cannot be retrieved later. Save both values in Notepad for use in later steps.

3. Create the OAuth Client in Your Deputy Business Instance

1. Go to your Deputy Instance OAuth Settings: https://<your‑instance>.deputy.com/exec/devapp/oauth_clients Example: https://ipmdemo.au.deputy.com/#exec/devapp/oauth_clients

2. Click New OAuth Client

   

3. Fill out same details as before:

   i. Name: you can reuse the same name

   ii. Redirect Uri: the same as before: 
   https://{client}.api.opcentral.com.au/roster/deputy/redirect

4. You do not need the Client ID or Client Secret from this local client.
5. Click Get An Access Token to generate a new lifetime AUTH token

6. Copy the Access Token to Notepad. This will be required in the next step. 

   

    

   4. Add the details in the Ideagen Procedure Management Rostering Setting

   1.  Go to System Settings

2. Go to Module Settings > Rostering:

   

3. Enter the details you saved to Notepad.

   i. Client ID

   ii. Client Secret

   iii. Access Token (this is pasted as the 'Permanent Token')

4. Add the Client End Point: this is the subdomain of your Deputy business instance. 

   Example: {clientname}.au.deputy.com

   

5. Click Save
6. Return to your Dashboard — you should now see the option to Connect to Deputy.

That's it! For more information see: Deputy Integration (Rostering) – Ideagen Procedure Management | Help | Ideagen Luminate