This document will explain what is needed to setup access to Device Pilot and install the connector.
API Key Setup
Go to the token settings in DevicePilot and create a new token. Select "POST" as the token type and enter an appropriate name.
Temporarily display the token by clicking "Show token" and note this down. It should start with "TOKEN".
In the connector setup enter the full API Key in the API Key textbox.
Update and Insert device data
DevicePilot allows users to submit any data that is relevant to their devices. Because of this, Cyclr lets you choose your own fields that you want to submit. To choose your own field, you can create request custom fields.
DevicePilot manages webhooks, so you need to set webhooks up through the DevicePilot admin portal:
In Cyclr, add the webhook method that's present in the connector.
Select Step setup and note the webhook URL. It looks similar to
https://my.cyclr.com/api/webhook/ABC123, depending on your region.
Navigate to the connections area in DevicePilot.
Select Get Started underneath the "Webhooks" category to create a new webhook.
Enter in the appropriate details:
Set the URL to the Cyclr webhook URL (see step 1).
Set Method to
In the header, set
Authorizationto the API key that you entered in connector setup, and
content-typeis set to
The Body represents the response and data. The webhook setup should look similar to the following:
Save the changes.
You can find more information on the DevicePilot help page.