Create an automation

curl --request POST \
  --url https://api.scrip.dev/v1/programs/{programId}/automations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "name": "Weekly points reminder",
  "scope": "participants",
  "trigger": {
    "cron_expression": "0 9 * * 1",
    "timezone": "America/Chicago",
    "type": "cron"
  },
  "description": "Sends a weekly reminder event to VIP participants",
  "event_data": {},
  "filter_hints": [
    {
      "type": "has_tag",
      "value": "vip"
    }
  ],
  "guard_condition": "participant.counters.purchases >= 1",
  "participant_filter": "participant.tags.exists(t, t == 'vip')",
  "participant_id": "550e8400-e29b-41d4-a716-446655440001"
}
EOF

import requests

url = "https://api.scrip.dev/v1/programs/{programId}/automations"

payload = {
    "name": "Weekly points reminder",
    "scope": "participants",
    "trigger": {
        "cron_expression": "0 9 * * 1",
        "timezone": "America/Chicago",
        "type": "cron"
    },
    "description": "Sends a weekly reminder event to VIP participants",
    "event_data": {},
    "filter_hints": [
        {
            "type": "has_tag",
            "value": "vip"
        }
    ],
    "guard_condition": "participant.counters.purchases >= 1",
    "participant_filter": "participant.tags.exists(t, t == 'vip')",
    "participant_id": "550e8400-e29b-41d4-a716-446655440001"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Weekly points reminder',
    scope: 'participants',
    trigger: {cron_expression: '0 9 * * 1', timezone: 'America/Chicago', type: 'cron'},
    description: 'Sends a weekly reminder event to VIP participants',
    event_data: {},
    filter_hints: [{type: 'has_tag', value: 'vip'}],
    guard_condition: 'participant.counters.purchases >= 1',
    participant_filter: 'participant.tags.exists(t, t == \'vip\')',
    participant_id: '550e8400-e29b-41d4-a716-446655440001'
  })
};

fetch('https://api.scrip.dev/v1/programs/{programId}/automations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrip.dev/v1/programs/{programId}/automations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Weekly points reminder',
    'scope' => 'participants',
    'trigger' => [
        'cron_expression' => '0 9 * * 1',
        'timezone' => 'America/Chicago',
        'type' => 'cron'
    ],
    'description' => 'Sends a weekly reminder event to VIP participants',
    'event_data' => [
        
    ],
    'filter_hints' => [
        [
                'type' => 'has_tag',
                'value' => 'vip'
        ]
    ],
    'guard_condition' => 'participant.counters.purchases >= 1',
    'participant_filter' => 'participant.tags.exists(t, t == \'vip\')',
    'participant_id' => '550e8400-e29b-41d4-a716-446655440001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrip.dev/v1/programs/{programId}/automations"

	payload := strings.NewReader("{\n  \"name\": \"Weekly points reminder\",\n  \"scope\": \"participants\",\n  \"trigger\": {\n    \"cron_expression\": \"0 9 * * 1\",\n    \"timezone\": \"America/Chicago\",\n    \"type\": \"cron\"\n  },\n  \"description\": \"Sends a weekly reminder event to VIP participants\",\n  \"event_data\": {},\n  \"filter_hints\": [\n    {\n      \"type\": \"has_tag\",\n      \"value\": \"vip\"\n    }\n  ],\n  \"guard_condition\": \"participant.counters.purchases >= 1\",\n  \"participant_filter\": \"participant.tags.exists(t, t == 'vip')\",\n  \"participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scrip.dev/v1/programs/{programId}/automations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Weekly points reminder\",\n  \"scope\": \"participants\",\n  \"trigger\": {\n    \"cron_expression\": \"0 9 * * 1\",\n    \"timezone\": \"America/Chicago\",\n    \"type\": \"cron\"\n  },\n  \"description\": \"Sends a weekly reminder event to VIP participants\",\n  \"event_data\": {},\n  \"filter_hints\": [\n    {\n      \"type\": \"has_tag\",\n      \"value\": \"vip\"\n    }\n  ],\n  \"guard_condition\": \"participant.counters.purchases >= 1\",\n  \"participant_filter\": \"participant.tags.exists(t, t == 'vip')\",\n  \"participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/programs/{programId}/automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Weekly points reminder\",\n  \"scope\": \"participants\",\n  \"trigger\": {\n    \"cron_expression\": \"0 9 * * 1\",\n    \"timezone\": \"America/Chicago\",\n    \"type\": \"cron\"\n  },\n  \"description\": \"Sends a weekly reminder event to VIP participants\",\n  \"event_data\": {},\n  \"filter_hints\": [\n    {\n      \"type\": \"has_tag\",\n      \"value\": \"vip\"\n    }\n  ],\n  \"guard_condition\": \"participant.counters.purchases >= 1\",\n  \"participant_filter\": \"participant.tags.exists(t, t == 'vip')\",\n  \"participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Sends a weekly reminder event to VIP participants",
  "error_message": "participant not found",
  "event_data": {},
  "execution_completed_at": "2024-01-15T09:00:42Z",
  "execution_error": "fanout aborted: program is archived",
  "execution_started_at": "2024-01-15T09:00:00Z",
  "execution_status": "completed",
  "filter_hints": [
    {
      "type": "has_tag",
      "value": "vip"
    }
  ],
  "guard_condition": "participant.counters.purchases >= 1",
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "last_error": "failed to enqueue event: queue unavailable",
  "last_evaluated_at": "2024-01-15T10:30:00Z",
  "last_run_at": "2024-01-15T09:00:00Z",
  "name": "Weekly points reminder",
  "next_run_at": "2024-01-22T09:00:00Z",
  "participant_filter": "participant.tags.exists(t, t == 'vip')",
  "participant_id": "550e8400-e29b-41d4-a716-446655440001",
  "participants_processed": 150,
  "participants_skipped_error": 0,
  "participants_total": 150,
  "processed_at": "2024-02-01T09:00:05Z",
  "program_id": "550e8400-e29b-41d4-a716-446655440000",
  "scope": "participants",
  "source": "api",
  "source_event_id": "770e8400-e29b-41d4-a716-446655440000",
  "source_rule_id": "880e8400-e29b-41d4-a716-446655440000",
  "status": "active",
  "trigger": {
    "cron_expression": "0 9 * * 1",
    "timezone": "America/Chicago",
    "type": "cron"
  },
  "updated_at": "2024-01-15T10:30:00Z",
  "warnings": [
    {
      "client_ref": "<string>",
      "code": "unknown_state_key",
      "key": "purchaseCnt",
      "kind": "counter",
      "message": "unknown counter \"purchaseCnt\" — no rule in this program writes it; did you mean \"purchase_count\"?",
      "rule_id": "<string>",
      "rule_set_id": "<string>",
      "scope": "participant",
      "suggestion": "purchase_count"
    }
  ]
}

{
  "code": "bad_request",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Invalid request parameters"
}

{
  "code": "unauthorized",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Missing or invalid credentials"
}

{
  "code": "not_found",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Resource not found"
}

{
  "code": "conflict",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Resource already exists or state conflict"
}

{
  "code": "unsupported_media_type",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Content-Type must be application/json"
}

{
  "code": "internal_error",
  "message": "An internal error occurred"
}

POST

programs

{programId}

automations

Create an automation

curl --request POST \
  --url https://api.scrip.dev/v1/programs/{programId}/automations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "name": "Weekly points reminder",
  "scope": "participants",
  "trigger": {
    "cron_expression": "0 9 * * 1",
    "timezone": "America/Chicago",
    "type": "cron"
  },
  "description": "Sends a weekly reminder event to VIP participants",
  "event_data": {},
  "filter_hints": [
    {
      "type": "has_tag",
      "value": "vip"
    }
  ],
  "guard_condition": "participant.counters.purchases >= 1",
  "participant_filter": "participant.tags.exists(t, t == 'vip')",
  "participant_id": "550e8400-e29b-41d4-a716-446655440001"
}
EOF

import requests

url = "https://api.scrip.dev/v1/programs/{programId}/automations"

payload = {
    "name": "Weekly points reminder",
    "scope": "participants",
    "trigger": {
        "cron_expression": "0 9 * * 1",
        "timezone": "America/Chicago",
        "type": "cron"
    },
    "description": "Sends a weekly reminder event to VIP participants",
    "event_data": {},
    "filter_hints": [
        {
            "type": "has_tag",
            "value": "vip"
        }
    ],
    "guard_condition": "participant.counters.purchases >= 1",
    "participant_filter": "participant.tags.exists(t, t == 'vip')",
    "participant_id": "550e8400-e29b-41d4-a716-446655440001"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Weekly points reminder',
    scope: 'participants',
    trigger: {cron_expression: '0 9 * * 1', timezone: 'America/Chicago', type: 'cron'},
    description: 'Sends a weekly reminder event to VIP participants',
    event_data: {},
    filter_hints: [{type: 'has_tag', value: 'vip'}],
    guard_condition: 'participant.counters.purchases >= 1',
    participant_filter: 'participant.tags.exists(t, t == \'vip\')',
    participant_id: '550e8400-e29b-41d4-a716-446655440001'
  })
};

fetch('https://api.scrip.dev/v1/programs/{programId}/automations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrip.dev/v1/programs/{programId}/automations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Weekly points reminder',
    'scope' => 'participants',
    'trigger' => [
        'cron_expression' => '0 9 * * 1',
        'timezone' => 'America/Chicago',
        'type' => 'cron'
    ],
    'description' => 'Sends a weekly reminder event to VIP participants',
    'event_data' => [
        
    ],
    'filter_hints' => [
        [
                'type' => 'has_tag',
                'value' => 'vip'
        ]
    ],
    'guard_condition' => 'participant.counters.purchases >= 1',
    'participant_filter' => 'participant.tags.exists(t, t == \'vip\')',
    'participant_id' => '550e8400-e29b-41d4-a716-446655440001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrip.dev/v1/programs/{programId}/automations"

	payload := strings.NewReader("{\n  \"name\": \"Weekly points reminder\",\n  \"scope\": \"participants\",\n  \"trigger\": {\n    \"cron_expression\": \"0 9 * * 1\",\n    \"timezone\": \"America/Chicago\",\n    \"type\": \"cron\"\n  },\n  \"description\": \"Sends a weekly reminder event to VIP participants\",\n  \"event_data\": {},\n  \"filter_hints\": [\n    {\n      \"type\": \"has_tag\",\n      \"value\": \"vip\"\n    }\n  ],\n  \"guard_condition\": \"participant.counters.purchases >= 1\",\n  \"participant_filter\": \"participant.tags.exists(t, t == 'vip')\",\n  \"participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scrip.dev/v1/programs/{programId}/automations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Weekly points reminder\",\n  \"scope\": \"participants\",\n  \"trigger\": {\n    \"cron_expression\": \"0 9 * * 1\",\n    \"timezone\": \"America/Chicago\",\n    \"type\": \"cron\"\n  },\n  \"description\": \"Sends a weekly reminder event to VIP participants\",\n  \"event_data\": {},\n  \"filter_hints\": [\n    {\n      \"type\": \"has_tag\",\n      \"value\": \"vip\"\n    }\n  ],\n  \"guard_condition\": \"participant.counters.purchases >= 1\",\n  \"participant_filter\": \"participant.tags.exists(t, t == 'vip')\",\n  \"participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/programs/{programId}/automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Weekly points reminder\",\n  \"scope\": \"participants\",\n  \"trigger\": {\n    \"cron_expression\": \"0 9 * * 1\",\n    \"timezone\": \"America/Chicago\",\n    \"type\": \"cron\"\n  },\n  \"description\": \"Sends a weekly reminder event to VIP participants\",\n  \"event_data\": {},\n  \"filter_hints\": [\n    {\n      \"type\": \"has_tag\",\n      \"value\": \"vip\"\n    }\n  ],\n  \"guard_condition\": \"participant.counters.purchases >= 1\",\n  \"participant_filter\": \"participant.tags.exists(t, t == 'vip')\",\n  \"participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Sends a weekly reminder event to VIP participants",
  "error_message": "participant not found",
  "event_data": {},
  "execution_completed_at": "2024-01-15T09:00:42Z",
  "execution_error": "fanout aborted: program is archived",
  "execution_started_at": "2024-01-15T09:00:00Z",
  "execution_status": "completed",
  "filter_hints": [
    {
      "type": "has_tag",
      "value": "vip"
    }
  ],
  "guard_condition": "participant.counters.purchases >= 1",
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "last_error": "failed to enqueue event: queue unavailable",
  "last_evaluated_at": "2024-01-15T10:30:00Z",
  "last_run_at": "2024-01-15T09:00:00Z",
  "name": "Weekly points reminder",
  "next_run_at": "2024-01-22T09:00:00Z",
  "participant_filter": "participant.tags.exists(t, t == 'vip')",
  "participant_id": "550e8400-e29b-41d4-a716-446655440001",
  "participants_processed": 150,
  "participants_skipped_error": 0,
  "participants_total": 150,
  "processed_at": "2024-02-01T09:00:05Z",
  "program_id": "550e8400-e29b-41d4-a716-446655440000",
  "scope": "participants",
  "source": "api",
  "source_event_id": "770e8400-e29b-41d4-a716-446655440000",
  "source_rule_id": "880e8400-e29b-41d4-a716-446655440000",
  "status": "active",
  "trigger": {
    "cron_expression": "0 9 * * 1",
    "timezone": "America/Chicago",
    "type": "cron"
  },
  "updated_at": "2024-01-15T10:30:00Z",
  "warnings": [
    {
      "client_ref": "<string>",
      "code": "unknown_state_key",
      "key": "purchaseCnt",
      "kind": "counter",
      "message": "unknown counter \"purchaseCnt\" — no rule in this program writes it; did you mean \"purchase_count\"?",
      "rule_id": "<string>",
      "rule_set_id": "<string>",
      "scope": "participant",
      "suggestion": "purchase_count"
    }
  ]
}

{
  "code": "bad_request",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Invalid request parameters"
}

{
  "code": "unauthorized",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Missing or invalid credentials"
}

{
  "code": "not_found",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Resource not found"
}

{
  "code": "conflict",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Resource already exists or state conflict"
}

{
  "code": "unsupported_media_type",
  "details": {
    "expected": "<string>",
    "field": "<string>",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "<string>",
        "message": "This field is required",
        "reason": "required",
        "received": "<string>"
      }
    ],
    "reason": "invalid",
    "received": "<string>"
  },
  "message": "Content-Type must be application/json"
}

{
  "code": "internal_error",
  "message": "An internal error occurred"
}

Creates an automation scoped to a program. An automation stores the event_data you would send to POST /v1/events and submits it unchanged when its trigger fires. At minimum you must provide name, trigger, and scope. If you want rules to match on event.type, set type inside event_data yourself, exactly as you would on any other event. The trigger.type can be cron, one_time, or participant_state. A one_time trigger with trigger_at omitted fires immediately. The participant_state type requires participants scope; cron and one_time accept either scope. An invalid combination is rejected with a validation error. For one_time automations with scope set to program, you can optionally include participant_id to target a specific participant. This sends the event to that participant rather than to the program at large.

For usage patterns and examples, see the Automations guide.

Authorizations

X-API-Key

string

header

required

API key passed in the X-API-Key header.

Path Parameters

programId

string<uuid>

required

Program ID

Body

application/json

Automation configuration

name

string

required

Human-readable label for this automation (1-255 chars)

Required string length: 1 - 255

Example:

"Weekly points reminder"

scope

enum<string>

required

Whether the automation fires once at the program level or fans out per participant: program or participants

Available options:

program,

participants

Example:

"participants"

trigger

object

required

Trigger configuration (type, schedule, timing)

Show child attributes

Example:

{
  "cron_expression": "0 9 * * 1",
  "timezone": "America/Chicago",
  "type": "cron"
}

description

string

Optional human-readable description of what this automation does

Example:

"Sends a weekly reminder event to VIP participants"

event_data

object

JSON object stored with the automation and submitted unchanged when its trigger fires

filter_hints

Automation filter hint · object[]

Checks derived from participant_filter that narrow the participants to consider. Scrip still evaluates the full CEL filter for each candidate.

Show child attributes

guard_condition

string

CEL expression evaluated at trigger time; skips the participant if false

Example:

"participant.counters.purchases >= 1"

participant_filter

string

CEL expression that determines which participants are enrolled (scope=participants only)

Example:

"participant.tags.exists(t, t == 'vip')"

participant_id

string<uuid>

Target participant for program-scoped one-time automations (scope=program, one_time trigger only)

Example:

"550e8400-e29b-41d4-a716-446655440001"

Response

Automation created

created_at

string<date-time>

When this automation was created

Example:

"2024-01-15T10:30:00Z"

description

string

Optional human-readable description of what this automation does

Example:

"Sends a weekly reminder event to VIP participants"

error_message

string

Error message if the one-time automation failed

Example:

"participant not found"

event_data

object

Event data submitted when this automation fires

execution_completed_at

string<date-time>

When the current fan-out execution completed

Example:

"2024-01-15T09:00:42Z"

execution_error

string

Error message if the fan-out execution failed, or JSON-encoded diagnostics for completed runs with CEL eval skips

Example:

"fanout aborted: program is archived"

execution_started_at

string<date-time>

When the current fan-out execution started

Example:

"2024-01-15T09:00:00Z"

execution_status

enum<string>

Status of the current run sending events to participants, separate from the automation's status.

idle: no run is in progress.
executing: participants are currently being processed.
completed: the current run finished; the automation definition may remain active for future runs.
failed: the current run stopped with an error; the automation definition may remain active for a retry or future run.

Available options:

idle,

executing,

completed,

failed

Example:

"completed"

filter_hints

Automation filter hint · object[]

Checks derived from participant_filter that narrow the participants to consider. Scrip still evaluates the full CEL filter for each candidate.

Show child attributes

guard_condition

string

CEL expression evaluated at trigger time; skips the participant if false

Example:

"participant.counters.purchases >= 1"

string<uuid>

Unique identifier for this automation

Example:

"990e8400-e29b-41d4-a716-446655440000"

last_error

string

Error message from the most recent cron execution, if any (cron trigger only)

Example:

"failed to enqueue event: queue unavailable"

last_evaluated_at

string<date-time>

When participant filters were last evaluated (participant_state trigger only)

Example:

"2024-01-15T10:30:00Z"

last_run_at

string<date-time>

When this automation last fired (cron trigger only)

Example:

"2024-01-15T09:00:00Z"

name

string

Human-readable label for this automation

Example:

"Weekly points reminder"

next_run_at

string<date-time>

When this automation will next fire (cron trigger only)

Example:

"2024-01-22T09:00:00Z"

participant_filter

string

CEL expression that determines which participants are enrolled

Example:

"participant.tags.exists(t, t == 'vip')"

participant_id

string<uuid>

Target participant for program-scoped one-time automations

Example:

"550e8400-e29b-41d4-a716-446655440001"

participants_processed

integer

Participants processed so far in the current run

Example:

150

participants_skipped_error

integer

Participants skipped because participant_filter or guard_condition CEL evaluation errored

Example:

0

participants_total

integer

Total participants to process in the current run

Example:

150

processed_at

string<date-time>

When this one-time automation was processed

Example:

"2024-02-01T09:00:05Z"

program_id

string<uuid>

The program this automation belongs to

Example:

"550e8400-e29b-41d4-a716-446655440000"

scope

string

Whether the automation sends one program event or an event for each selected participant: program or participants.

Example:

"participants"

source

enum<string>

Origin of the automation.

api: created directly through the Automations API.
rule_action: created by a SCHEDULE_EVENT or BROADCAST rule action.
system: created by Scrip for scheduled tasks such as tier expiration.

Available options:

api,

rule_action,

system

Example:

"api"

source_event_id

string<uuid>

The event whose processing created this automation. Omitted when no source event is recorded, for example on automations created through the API.

Example:

"770e8400-e29b-41d4-a716-446655440000"

source_rule_id

string<uuid>

The rule whose action created this automation. Omitted when no rule action created it, including automations created through the API.

Example:

"880e8400-e29b-41d4-a716-446655440000"

status

enum<string>

Lifecycle state of the automation definition.

active: eligible to fire when its trigger is due.
paused: temporarily prevented from firing and may be reactivated.
completed: a one-time automation fired successfully and is terminal.
failed: stopped firing after a definition-level failure until explicitly reactivated.
archived: soft-deleted and permanently prevented from firing.

Available options:

active,

paused,

completed,

failed,

archived

Example:

"active"

trigger

object

Trigger configuration (type, schedule, and timing)

Show child attributes

Example:

{
  "cron_expression": "0 9 * * 1",
  "timezone": "America/Chicago",
  "type": "cron"
}

updated_at

string<date-time>

When this automation was last updated

Example:

"2024-01-15T10:30:00Z"

warnings

object[]

Non-blocking advisories about participant_filter/guard_condition — e.g. a counter/tag/attribute key no rule in the program writes. Present on create/update only; never blocks the save.

Show child attributes

Scrip API

Endpoints

Create an automation

Authorizations

Path Parameters

Body

Response