Siemplify’s SDK was designed to help developers communicate and utilize various API functionalities. The SDK can be used from Siemplify’s IDE in one of the three object types available in Siemplify:

  • Actions
    Actions are “stand alone” Python scripts that can be called, like functions, from either a playbook or manually by a user. A SiemplifyAction has (dynamic – based on alert data) data and configuration/parameters as input, and either returns a value or performs an action (or both).
  • Connectors
    Connectors are time-based Python scripts that run every predefined time interval with the purpose of creating new alerts in Siemplify (Ingesting new data). In principle, a connector is compared with a class in Python, as you create its definition once, but you can then instantiate multiple instances that can co-exist. A connector has only parameters as input, and nothing is dynamic (unless expressed in the logic).
  • Jobs
    Jobs are time-based Python scripts that run every predefined time interval. The difference between jobs and connectors is mainly their purpose. Connectors are responsible for creating new alerts in Siemplify, whereas jobs are usually used to sync data or maintenance.

The three objects above represent three types of automation (based on Python) that Siemplify utilizes and are presented in more detail in the next sections.
These 3 objects inherit from a more generic wrapper to Siemplify’s API: “siemplify” and “siemplifybase