Create workflow rule

Create an workflow rule with its conditions and actions.

POST /v1/workflow-rules

Create workflow rule

cURL

curl --request POST \
  --url http://localhost:8080/api/v1/workflow-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "provider_slug": "<string>",
  "ping_target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "cooldown_minutes": 5040,
  "conditions": [
    {
      "value": "<string>",
      "lookback_minutes": 60,
      "sort_order": 123
    }
  ],
  "actions": [
    {
      "mail_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "recipient_email": "[e-mail]",
      "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "apprise_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sort_order": 123
    }
  ]
}
'

201

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "provider_slug": "<string>",
    "ping_target_id": "<string>",
    "target_label": "<string>",
    "target_host": "<string>",
    "event": "<string>",
    "event_label": "Speedtest run completes",
    "condition_operator": "<string>",
    "is_active": true,
    "cooldown_minutes": 123,
    "last_triggered_at": "<string>",
    "conditions": [
      {
        "id": "<string>",
        "metric": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "lookback_minutes": 123,
        "sort_order": 123
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "type": "<string>",
        "mail_provider_id": "<string>",
        "email_template_id": "<string>",
        "recipient_email": "<string>",
        "webhook_id": "<string>",
        "apprise_id": "<string>",
        "sort_order": 123
      }
    ],
    "created_at": "<string>"
  },
  "success": true,
  "code": 201,
  "message": "Workflow rule created successfully."
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Maximum string length: 255

event · enum<string> · required

Available options: run_completes, run_fails, run_skipped, any, ping

condition_operator · enum<string> · required

Available options: and, or

provider_slug · string | null

ping_target_id · string<uuid> | null

is_active · boolean

cooldown_minutes · integer

Required range: 0 <= x <= 10080

conditions · object[]

Hide child attributes

conditions. metric · enum<string> · required

Available options: status, download_mbps, upload_mbps, ping_ms, jitter_ms, packet_loss, latency_avg, latency_max, consecutive_failures

conditions. operator · enum<string> · required

Available options: is, is_not, is_above, is_below, is_above_or_equal, is_below_or_equal

conditions. value · string · required

conditions. lookback_minutes · integer | null

Required range: 1 <= x <= 120

conditions. sort_order · integer

actions · object[]

Minimum array length: 1

Hide child attributes

actions. type · enum<string> · required

Available options: email, webhook, apprise

actions. mail_provider_id · string<uuid> | null

actions. email_template_id · string<uuid> | null

actions. recipient_email · string<email> | null

actions. webhook_id · string<uuid> | null

actions. apprise_id · string<uuid> | null

actions. sort_order · integer

Response

201

application/json

WorkflowRuleResource

data · WorkflowRuleResource · object · required

Hide child attributes

data. id · string · required

data. name · string · required

data. provider_slug · string | null · required

data. ping_target_id · string | null · required

data. target_label · string | null · required

data. target_host · string | null · required

data. event · string · required

data. event_label · enum<string> · required

Available options: Speedtest run completes, Speedtest run fails, Speedtest run is skipped, Any speedtest event, Ping result recorded

data. condition_operator · string · required

data. is_active · boolean · required

data. cooldown_minutes · integer · required

data. last_triggered_at · string | null · required

data. conditions · object[] · required

Hide child attributes

data.conditions. id · string · required

data.conditions. metric · string · required

data.conditions. operator · string · required

data.conditions. value · string · required

data.conditions. lookback_minutes · integer | null · required

data.conditions. sort_order · integer · required

data. actions · object[] · required

Hide child attributes

data.actions. id · string · required

data.actions. type · string · required

data.actions. mail_provider_id · string | null · required

data.actions. email_template_id · string | null · required

data.actions. recipient_email · string | null · required

data.actions. webhook_id · string | null · required

data.actions. apprise_id · string | null · required

data.actions. sort_order · integer · required

data. created_at · string · required

success · boolean · required

code · integer · required

message · string · required

Allowed value: "Workflow rule created successfully."