CreateAutomationTrigger

curl --request POST \
  --url https://api.siftstack.com/api/v1/automation-triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "canvasId": "<string>",
  "name": "<string>",
  "actionKind": "AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED",
  "matchFilter": {
    "assetIds": [
      "<string>"
    ],
    "metadataMatches": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "actionParams": {},
  "isEnabled": true,
  "emailNotificationsEnabled": true,
  "notificationRecipientEmails": [
    "<string>"
  ],
  "reportNameTemplate": "<string>",
  "triggerKind": "AUTOMATION_TRIGGER_KIND_UNSPECIFIED",
  "cronExpression": "<string>",
  "timezone": "<string>"
}
'

import requests

url = "https://api.siftstack.com/api/v1/automation-triggers"

payload = {
    "canvasId": "<string>",
    "name": "<string>",
    "actionKind": "AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED",
    "matchFilter": {
        "assetIds": ["<string>"],
        "metadataMatches": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ]
    },
    "actionParams": {},
    "isEnabled": True,
    "emailNotificationsEnabled": True,
    "notificationRecipientEmails": ["<string>"],
    "reportNameTemplate": "<string>",
    "triggerKind": "AUTOMATION_TRIGGER_KIND_UNSPECIFIED",
    "cronExpression": "<string>",
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.siftstack.com/api/v1/automation-triggers"

	payload := strings.NewReader("{\n  \"canvasId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"actionKind\": \"AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED\",\n  \"matchFilter\": {\n    \"assetIds\": [\n      \"<string>\"\n    ],\n    \"metadataMatches\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"actionParams\": {},\n  \"isEnabled\": true,\n  \"emailNotificationsEnabled\": true,\n  \"notificationRecipientEmails\": [\n    \"<string>\"\n  ],\n  \"reportNameTemplate\": \"<string>\",\n  \"triggerKind\": \"AUTOMATION_TRIGGER_KIND_UNSPECIFIED\",\n  \"cronExpression\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "automationTrigger": {
    "automationTriggerId": "<string>",
    "organizationId": "<string>",
    "canvasId": "<string>",
    "name": "<string>",
    "userId": "<string>",
    "actionKind": "AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED",
    "isEnabled": true,
    "isArchived": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "emailNotificationsEnabled": true,
    "notificationRecipientEmails": [
      "<string>"
    ],
    "triggerKind": "AUTOMATION_TRIGGER_KIND_UNSPECIFIED",
    "matchFilter": {
      "assetIds": [
        "<string>"
      ],
      "nameMatch": {
        "kind": "AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_UNSPECIFIED",
        "value": "<string>"
      },
      "metadataMatches": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    },
    "actionParams": {
      "canvasEvaluation": {
        "canvasVersionId": "<string>",
        "paramJson": {}
      }
    },
    "archivedDate": "2023-11-07T05:31:56Z",
    "reportNameTemplate": "<string>",
    "cronExpression": "<string>",
    "timezone": "<string>",
    "nextFireAt": "2023-11-07T05:31:56Z",
    "lastFireAt": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

api

automation-triggers

CreateAutomationTrigger

curl --request POST \
  --url https://api.siftstack.com/api/v1/automation-triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "canvasId": "<string>",
  "name": "<string>",
  "actionKind": "AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED",
  "matchFilter": {
    "assetIds": [
      "<string>"
    ],
    "metadataMatches": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "actionParams": {},
  "isEnabled": true,
  "emailNotificationsEnabled": true,
  "notificationRecipientEmails": [
    "<string>"
  ],
  "reportNameTemplate": "<string>",
  "triggerKind": "AUTOMATION_TRIGGER_KIND_UNSPECIFIED",
  "cronExpression": "<string>",
  "timezone": "<string>"
}
'

import requests

url = "https://api.siftstack.com/api/v1/automation-triggers"

payload = {
    "canvasId": "<string>",
    "name": "<string>",
    "actionKind": "AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED",
    "matchFilter": {
        "assetIds": ["<string>"],
        "metadataMatches": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ]
    },
    "actionParams": {},
    "isEnabled": True,
    "emailNotificationsEnabled": True,
    "notificationRecipientEmails": ["<string>"],
    "reportNameTemplate": "<string>",
    "triggerKind": "AUTOMATION_TRIGGER_KIND_UNSPECIFIED",
    "cronExpression": "<string>",
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.siftstack.com/api/v1/automation-triggers"

	payload := strings.NewReader("{\n  \"canvasId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"actionKind\": \"AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED\",\n  \"matchFilter\": {\n    \"assetIds\": [\n      \"<string>\"\n    ],\n    \"metadataMatches\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"actionParams\": {},\n  \"isEnabled\": true,\n  \"emailNotificationsEnabled\": true,\n  \"notificationRecipientEmails\": [\n    \"<string>\"\n  ],\n  \"reportNameTemplate\": \"<string>\",\n  \"triggerKind\": \"AUTOMATION_TRIGGER_KIND_UNSPECIFIED\",\n  \"cronExpression\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "automationTrigger": {
    "automationTriggerId": "<string>",
    "organizationId": "<string>",
    "canvasId": "<string>",
    "name": "<string>",
    "userId": "<string>",
    "actionKind": "AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED",
    "isEnabled": true,
    "isArchived": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "emailNotificationsEnabled": true,
    "notificationRecipientEmails": [
      "<string>"
    ],
    "triggerKind": "AUTOMATION_TRIGGER_KIND_UNSPECIFIED",
    "matchFilter": {
      "assetIds": [
        "<string>"
      ],
      "nameMatch": {
        "kind": "AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_UNSPECIFIED",
        "value": "<string>"
      },
      "metadataMatches": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    },
    "actionParams": {
      "canvasEvaluation": {
        "canvasVersionId": "<string>",
        "paramJson": {}
      }
    },
    "archivedDate": "2023-11-07T05:31:56Z",
    "reportNameTemplate": "<string>",
    "cronExpression": "<string>",
    "timezone": "<string>",
    "nextFireAt": "2023-11-07T05:31:56Z",
    "lastFireAt": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

The request for a call to AutomationService_CreateAutomationTrigger.

canvasId

string

required

name

string

required

actionKind

enum<string>

default:AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED

required

AutomationTriggerActionKind is what a trigger does when it fires. v1 is CANVAS_EVALUATION only.

Available options:

AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED,

AUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION

matchFilter

object

AutomationTriggerMatchFilter selects which stopped runs a trigger matches. Empty asset_ids, absent name_match, and empty metadata_matches each match any value. Dimensions are AND'd. STARTS_WITH / ENDS_WITH / CONTAINS are case-insensitive; REGEX is Go regexp (add (?i) for case-insensitive).

Show child attributes

actionParams

object

AutomationTriggerActionParams is the public action_params shape, oneof by action kind.

Show child attributes

isEnabled

boolean

emailNotificationsEnabled

boolean

Defaults to true when unset.

notificationRecipientEmails

string[]

Defaults to the creating user's address when empty.

reportNameTemplate

string

Names the reports this automation publishes, stored on the trigger. Omit it to let the server apply the run-aware default: when the trigger binds a triggering run and the canvas has no template of its own, the new trigger is given one naming its reports after that run. See sift_internal.canvas.v1.Canvas.report_name_template for the syntax.

triggerKind

enum<string>

default:AUTOMATION_TRIGGER_KIND_UNSPECIFIED

AutomationTriggerKind is the source that causes a trigger to fire.

AUTOMATION_TRIGGER_KIND_RUN_STOP: Fire after a matching run stops.
AUTOMATION_TRIGGER_KIND_SCHEDULE: Fire on a recurring cron cadence in an IANA timezone.

Reserved. Create/Update reject this value.

Available options:

AUTOMATION_TRIGGER_KIND_UNSPECIFIED,

AUTOMATION_TRIGGER_KIND_RUN_STOP,

AUTOMATION_TRIGGER_KIND_SCHEDULE

cronExpression

string

Required when trigger_kind is SCHEDULE.

timezone

string

IANA timezone. Required when trigger_kind is SCHEDULE.

Response

A successful response.

The response of a call to AutomationService_CreateAutomationTrigger.

automationTrigger

object

required

AutomationTrigger is a Canvas Scheduler rule: match a stopped run or fire on a cron cadence, then dispatch (v1: EvaluateCanvas).

Show child attributes

Authenticate

Clients

Review

Export

Attachments

Reference

CreateAutomationTrigger

Authorizations

Body

Response