Skip to main content
PUT
/
v1
/
orgs
/
{org_id}
/
rules
/
Create a rule
curl --request PUT \
  --url https://api.arklow.io/v1/orgs/{org_id}/rules/ \
  --header 'Content-Type: application/json' \
  --header 'x-arklow-auth: <api-key>' \
  --data '
{
  "name": "<string>",
  "expression": "<string>",
  "effect": "dispatch",
  "action_definition_id": "<string>",
  "status": "active",
  "priority": 123,
  "phase": "<string>",
  "effect_payload": "<unknown>"
}
'
{
  "data": {
    "id": "<string>",
    "org_id": "<string>",
    "name": "<string>",
    "status": "active",
    "expression": "<string>",
    "priority": 123,
    "phase": "<string>",
    "effect": "dispatch",
    "action_definition_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "effect_payload": "<unknown>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "action_definition": {
      "id": "<string>",
      "org_id": "<string>",
      "variant": "<string>",
      "version": 123,
      "alias": [
        "<string>"
      ],
      "schema": "<unknown>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "destinations": [
        {
          "id": "<string>",
          "action_definition_id": "<string>",
          "destination_id": "<string>",
          "org_id": "<string>",
          "is_default": true,
          "destination": {
            "id": "<string>",
            "org_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "label": "<string>",
            "type": "webhook",
            "config": {
              "url": "<string>",
              "headers": {},
              "signaling": {
                "enabled": true,
                "default": "ack"
              },
              "response_time_sla_ms": 2
            },
            "deleted_at": "2023-11-07T05:31:56Z",
            "tags": {},
            "credential_id": "<string>"
          }
        }
      ]
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

x-arklow-auth
string
header
required

Path Parameters

org_id
string
required
Pattern: ^[0-9]+$

Body

application/json
name
string
required
expression
string
required
effect
required
Available options:
dispatch
action_definition_id
string
required
status
Available options:
active
priority
integer
phase
string
effect_payload
any

Response

200 - application/json

Default Response

data
object
required
errors
object[] | null
required