Skip to main content

Developer Tools

Developer Tools is accessible to users with the Developer role. It provides two capabilities for integrating programmatically with the Shoplogix IMS platform: API Credentials and Webhooks.

To reach it, navigate to Developer Tools in the left sidebar.

API Credentials​

API credentials authenticate machine-to-machine access to the IMS REST API. Each credential consists of a client ID and a client secret that you exchange for an OAuth 2.0 Bearer token using the client credentials flow.

Creating a Credential​

  1. Go to Developer Tools > API Credentials
  2. Select Add
  3. Enter a name that identifies the integration (e.g., "SCADA Integration", "Data Pipeline")
  4. Select the customer account scope
  5. Select the privilege level the credential should act with
  6. Optionally set an expiration date; leave blank for a non-expiring credential
  7. Click Save

The client secret is displayed once immediately after creation. Copy it now — it cannot be retrieved again. If you close the dialog without copying it, you must rotate the credential to get a new secret.

Rotating a Secret​

To generate a new secret without changing the client ID:

  1. Find the credential in API Credentials
  2. Select Rotate Secret
  3. Copy the new secret immediately — it is shown once
  4. Update any integrations using the old secret before the rotation takes effect

The old secret is invalidated as soon as the rotation completes.

Deleting a Credential​

  1. Find the credential in API Credentials
  2. Select Delete and confirm

Deletion immediately invalidates all tokens issued to that client ID. Any integration using the deleted credential will receive 401 Unauthorized responses. There is no grace period.

Credentials are scoped to your customer account. You cannot use a credential to access data outside the accounts it was granted access to at creation time.

Webhooks​

Webhooks push event data to an HTTP endpoint you control when machine or steam trap states change on the platform. They are an alternative to polling the REST API for state updates.

Creating a Webhook​

  1. Go to Developer Tools > Webhooks
  2. Select Add Webhook
  3. Fill in the webhook details:
FieldNotes
Callback URLThe HTTPS endpoint that will receive event payloads
Event TypeChoose one event type per webhook: machine-alarm-state-change-event or trap-state-change-event
EnabledToggle the webhook on or off
HeadersOptional custom headers to include in each delivery request, as a JSON array: [{"key": "x-api-key", "value": "your-key"}]
  1. Click Add Webhook

A signing secret is generated when the webhook is created. Copy it immediately — it is shown only once and is used to verify the authenticity of payloads delivered to your endpoint.

Managing Webhooks​

From the Webhooks list, click any row to open the webhook detail page. From there you can:

  • Enable or disable the webhook without deleting it — disabled webhooks do not deliver events
  • Update the callback URL or headers
  • Delete the webhook — delivery to that endpoint stops immediately

Event type cannot be changed after creation. To change the event type, delete the existing webhook and create a new one.

Deleting a Webhook​

  1. Open the webhook from the Webhooks list
  2. Select Delete and confirm

Event delivery to the endpoint stops immediately upon deletion.

  • Webhooks — payload formats, delivery guarantees, and signature verification
  • REST API — full API reference and token exchange flow
  • User Management — role and privilege descriptions