List automations

curl --request GET \
  --url https://{instance}/api/v1/automations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}/api/v1/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://{instance}/api/v1/automations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{instance}/api/v1/automations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}/api/v1/automations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "enabled": true,
      "status": "draft",
      "triggerEvent": "<string>",
      "trigger": "<unknown>",
      "conditions": "<unknown>",
      "actions": "<unknown>",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definitionVersion": 123,
      "approvalRequestedAt": "<string>",
      "approvedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "approvedAt": "<string>",
      "publishedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "publishedAt": "<string>",
      "maxRunsPerMinute": 123,
      "maxExternalActionsPerMinute": 123,
      "circuitBreakerThreshold": 123,
      "circuitBreakerCooldownSeconds": 123,
      "circuitOpenUntil": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "nextCursor": "<string>",
      "hasMore": true,
      "limit": 123
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

GET

api

automations

List automations

curl --request GET \
  --url https://{instance}/api/v1/automations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}/api/v1/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://{instance}/api/v1/automations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{instance}/api/v1/automations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}/api/v1/automations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "enabled": true,
      "status": "draft",
      "triggerEvent": "<string>",
      "trigger": "<unknown>",
      "conditions": "<unknown>",
      "actions": "<unknown>",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definitionVersion": 123,
      "approvalRequestedAt": "<string>",
      "approvedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "approvedAt": "<string>",
      "publishedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "publishedAt": "<string>",
      "maxRunsPerMinute": 123,
      "maxExternalActionsPerMinute": 123,
      "circuitBreakerThreshold": 123,
      "circuitBreakerCooldownSeconds": 123,
      "circuitOpenUntil": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "nextCursor": "<string>",
      "hasMore": true,
      "limit": 123
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Query Structure

query($filter: AutomationFilterType) {
  automations {
    all(filter: $filter) {
      edges {
        node {
          id
          name
          resource_name
          event
          enabled
          integration_id
          created_at
        }
      }
    }
  }
}

Filter Argument

All filters are passed inside the filter argument. Each field accepts an input object with operators.

Available Filters

Filter	Input Type	Operators	Description
`name`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Automation name
`resource_name`	ResourceNameInputType	`eq`	Triggering resource (e.g. goods_out)
`event`	EventInputType	`eq`	Triggering event (e.g. completed)
`enabled`	BooleanInputType	`eq`	Active status
`integration_id`	IdInputType	`eq`, `in`, `filled`	Linked integration
`created_at`	DatetimeInputType	`eq`, `from`, `to`, `between`	Creation time

More fields and filters available via GraphQL introspection.

Authorizations

Authorization

string

header

required

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

Response

data

object[]

required

Show child attributes

Get started

Tutorials

Using Harly

Deploy Harly

Integrations

Security

API and automation

API Reference

Operations

List automations

Query Structure

Filter Argument

Available Filters

Authorizations

Response

​Query Structure

​Filter Argument

​Available Filters

Authorizations

Response

Query Structure

Filter Argument

Available Filters