menu

My Demeter Documentation

Minions

What are minions?

Minions are a simple way of allowing processes to transfer data to external systems that processes wouldn't otherwise be able to interact with. To put it another way, minions allow processes to communicate with systems outside of WMS.

There are 2 primary ways of minions talking to other systems; a minion can go to the external system and ask for data to put into a process or it can wait for the external system to provide data to the process.

Minions are WMS's way of communicating with the outside world however, external systems may refer to this functionality as webhooks so if you have used webhooks then you will have a good understanding of what and how minions work.

How to create a minion

NOTE: Creating a Minion only applies when you need to retrieve data from the outside world. Check out the API URLs for outside systems sending data into a process.

Minions are configured in the process design when a process version is in the "Draft" status. Add an integration task to your process and in the right hand side of the page you will find settings for your minion.

This API Key is used for authentication when using the API URLs

You can create a new API key for the process by clicking selecting a process design, in the right hand side bar selecting API which will open a page where you can generate an API key for the process. Please note that the API section in the right hand side is restricted via a user license.

Click the  button at the top of the page to create an API key, in here you can give the API Key a name and a date for when it will expire (by default the expiration date will be set to a year from the date you are creating the key.

Once you click generate a pop up will appear stating this is your bearer token, save this as once you close the dialog box, the key is no longer visible to the user in the platform.

To view or edit the API key set up you can click on the API key in the grid when generated. You can update the name and expiry date of the API Key.

To delete (revoke) an existing API Key click button in the grid, a pop up will load confirming revoking the API Key, check the box to understand this cannot be undone and click Revoke

Last updated: 10 September 2024 10:54 AM
help_outline
close