Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

General Automations

Prev Next

Servitly allows defining automations, which are executed on environment-specific events, to trigger actions, like calling a third-party system API.

Creating an Automation

To add a new Automation to a Thing Definition, you should:

  1. Enter the Automations page.

  2. Select the General tab.

  3. Press the Add Automation button.

  4. Provide the required information.

  5. Press the Save button and edit the additional information, if needed.

Editing an Automation

By selecting an Automation, you can edit its properties, including the event and the related actions to be executed.

Automation Events

According to the event type, different conditions can then be specified.

  • On Partner/Customer/Location/Thing/User Created/Updated/Deleted: Triggered whenever an object  (Partner, Customer, Location, Thing, User) is created, updated, or deleted in the DPS.

  • On Command Executed (DEPRECATED): Triggered whenever a user executes a command on a thing.

  • On Parameter Updated (DEPRECATED): Triggered whenever a user updates a parameter on a thing.

  • On Payment Updated: Triggered whenever a payment record is modified.

  • On Store Order Created: Triggered whenever a store order is placed.

  • On Store Order Status Updated: Triggered whenever a store order status is updated (e.g., PENDING_APPROVAL → A APPROVED).

  • On Subscription Updated: Triggered whenever a subscription is modified.

  • On Ticket Created/Updated: Triggered whenever a ticket is created or modified.

  • On Ticket Status Updated: Triggered whenever a ticket status is changed (e.g., OPEN → IN PROGRESS).

  • On Work Session Started: Triggered whenever a work session is started.

  • On Work Session Stopped: Triggered whenever a work session is completed.

Automation Conditions

You can define one or more property-based conditions to be evaluated on the object where the event has occurred.
If the conditions are verified (all in AND), the defined actions are executed.

Conditions can be defined on all events related to Thing, Location, Customer, Partner, and User objects.

Automation Actions

The automation allows configuring the actions to be triggered when the condition is verified.

You can define multiple actions of the following types:

  • Notification: email a specific address, including the body information of the event context.

  • REST API: performs an HTTPS request on an external REST API.
    This action supports authentication, header configuration, and payload configuration in case of POST/PUT methods.

Within the action configuration, you can use placeholders to include dynamic content.

Automation Execution policy

The automation is periodically evaluated. For more details, refer to the Periodic Computations article.