Skip to main content

Plant alert

Webhook

Plant alert notifications are triggered when Gardin Pulse detects significant changes in plant health or light use efficiency based on chlorophyll fluorescence measurements. These alerts help growers respond quickly to emerging issues before they impact crop yield or quality.

Alerts are generated when plant indices cross defined thresholds, indicating conditions such as:

  • Critical stress: Immediate intervention required - health index has dropped below minimum acceptable levels
  • Early stress detection: Plants showing early signs of stress before visible symptoms appear
  • Light deficiency: Insufficient light affecting photosynthetic efficiency
  • Recovery: Plants recovering from a previous stress condition

For detailed setup instructions, code examples, webhook signature verification, and WebSocket connection details, see the Notification API Guide.

Required scope(s): [notifications[.alerts]:subscribe]

Events​

  • RAISED: A new plant alert has been detected.
  • CLOSED: A plant alert condition has resolved.

Alert Categories​

  • PLANT_CRITICAL_ALERT: Health index below minimum threshold - immediate attention required.
  • PLANT_STRESS_ALERT: Health index below moving average threshold - plants showing early signs of stress.
  • PLANT_LIGHT_ALERT: Efficiency index below minimum threshold - insufficient light conditions.
  • PLANT_RECOVERY_ALERT: Health index above moving average threshold - plants are recovering.

Request​

Header Parameters

    Gardin-Signature stringrequired

    HMAC-SHA256 signature of the payload, used to verify the authenticity of the request. Obtain your unique secret key from the Gardin Management Console to verify the signature.

Body

    alertCategory stringrequired

    Possible values: [PLANT_LIGHT_ALERT, PLANT_CRITICAL_ALERT, PLANT_STRESS_ALERT, PLANT_RECOVERY_ALERT]

    The category of the plant alert, derived from the alert type and trigger conditions.

    alertId stringrequired

    The unique identifier for the alert, represented as a ULID.

    closedAt date-time

    The timestamp when the alert was closed (RFC-3339 format). Only present for CLOSED events.

    controlAreaId stringrequired

    The unique identifier for the control area associated with the alert, represented as a ULID.

    createdAt date-timerequired

    The timestamp when the alert was created (RFC-3339 format).

    displayName stringrequired

    Possible values: [Light alert, Critical alert, Stress alert, Recovery alert]

    A human-readable name for the alert category.

    displayPath string

    A human-readable path showing the location hierarchy where the alert occurred.

    event stringrequired

    Possible values: [RAISED, CLOSED]

    The event that triggered the notification.

    jobId stringrequired

    The unique identifier of the growth job associated with the alert, represented as a ULID.

    locationId stringrequired

    The unique identifier of the location where the alert occurred, represented as a ULID.

    name stringrequired

    A short name or identifier for the alert.

    notificationId stringrequired

    The unique identifier for this notification, represented as a ULID.

    notificationType stringrequired

    Possible values: [alert]

    The type of notification. Use this field to determine how to process the notification payload.

    path stringrequired

    The internal path identifier representing the location hierarchy.

    state stringrequired

    Possible values: [ACTIVE, CLOSED]

    The current state of the alert.

    tenantId stringrequired

    The identifier for your tenancy, represented as a ULID.

    timestamp date-timerequired

    The timestamp when the event occurred (RFC-3339 format).

Responses​

API users can return a HTTP 200 OK status to indicate that the data was received successfully.

Loading...