Automations

Rules that act on project events.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
name	string(200)	Automation name.
triggertype	integer	What fires the automation: 0 = status changed, 1 = task assigned, 2 = due date reached, 3 = due date approaching, 4 = task created, 5 = milestone completed, 6 = priority changed.
triggervalue	text	Triggervalue. Stored as `text`, no practical length limit.
actiontype	integer	What the automation does: 0 = change status, 1 = reassign task, 2 = set priority, 3 = add tag, 4 = send notification, 5 = add comment.
actionvalue	text	Actionvalue. Stored as `text`, no practical length limit.
enabled	boolean	True while the automation is active.
sortorder	integer	Display order. Lower sorts first.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/teamprojectautomations/batch 207

Create many.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
name	string(200)	Automation name.
triggertype	integer	What fires the automation: 0 = status changed, 1 = task assigned, 2 = due date reached, 3 = due date approaching, 4 = task created, 5 = milestone completed, 6 = priority changed.
triggervalue	text	Triggervalue. Stored as `text`, no practical length limit.
actiontype	integer	What the automation does: 0 = change status, 1 = reassign task, 2 = set priority, 3 = add tag, 4 = send notification, 5 = add comment.
actionvalue	text	Actionvalue. Stored as `text`, no practical length limit.
enabled	boolean	True while the automation is active.
sortorder	integer	Display order. Lower sorts first.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "teamprojectid": 104,
        "teamproject": "Example teamproject",
        "name": "Example name",
        "triggertype": 1,
        "triggervalue": "Example triggervalue",
        "actiontype": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectautomations/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'teamprojectid' => 104,
      'teamproject' => 'Example teamproject',
      'name' => 'Example name',
      'triggertype' => 1,
      'triggervalue' => 'Example triggervalue',
      'actiontype' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "teamprojectid": 104,
            "teamproject": "Example teamproject",
            "name": "Example name",
            "triggertype": 1,
            "triggervalue": "Example triggervalue",
            "actiontype": 1,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        teamprojectid: 104,
        teamproject: "Example teamproject",
        name: "Example name",
        triggertype: 1,
        triggervalue: "Example triggervalue",
        actiontype: 1,
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        teamprojectid = 104,
        teamproject = "Example teamproject",
        name = "Example name",
        triggertype = 1,
        triggervalue = "Example triggervalue",
        actiontype = 1,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/teamprojectautomations 200403

List automations.

Requires scope projects:read.

Parameters

Name	In	Type	Notes
name	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
modifiedsince	query	string	RFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so `cancel` defaults to any rather than `false` when this is used. The response carries `_meta.synced_through`; store it and send it back next time.
externalid	query	string	Exact match on your own key.
teamprojectid	query	string	Filter to one .
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks read scope.

curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectautomations');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations");
res.EnsureSuccessStatusCode();

POST/teamprojectautomations 201400

Create.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
name	string(200)	Automation name.
triggertype	integer	What fires the automation: 0 = status changed, 1 = task assigned, 2 = due date reached, 3 = due date approaching, 4 = task created, 5 = milestone completed, 6 = priority changed.
triggervalue	text	Triggervalue. Stored as `text`, no practical length limit.
actiontype	integer	What the automation does: 0 = change status, 1 = reassign task, 2 = set priority, 3 = add tag, 4 = send notification, 5 = add comment.
actionvalue	text	Actionvalue. Stored as `text`, no practical length limit.
enabled	boolean	True while the automation is active.
sortorder	integer	Display order. Lower sorts first.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "name": "Example name",
    "triggertype": 1,
    "triggervalue": "Example triggervalue",
    "actiontype": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectautomations');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'teamprojectid' => 104,
    'teamproject' => 'Example teamproject',
    'name' => 'Example name',
    'triggertype' => 1,
    'triggervalue' => 'Example triggervalue',
    'actiontype' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "teamprojectid": 104,
        "teamproject": "Example teamproject",
        "name": "Example name",
        "triggertype": 1,
        "triggervalue": "Example triggervalue",
        "actiontype": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      teamprojectid: 104,
      teamproject: "Example teamproject",
      name: "Example name",
      triggertype: 1,
      triggervalue: "Example triggervalue",
      actiontype: 1,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    teamprojectid = 104,
    teamproject = "Example teamproject",
    name = "Example name",
    triggertype = 1,
    triggervalue = "Example triggervalue",
    actiontype = 1,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "name": "Example name",
    "triggertype": 1,
    "triggervalue": "Example triggervalue",
    "actiontype": 1
}

GET/teamprojectautomations/{id} 200404

Retrieve one record.

Requires scope projects:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectautomations/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "name": "Example name",
    "triggertype": 1,
    "triggervalue": "Example triggervalue",
    "actiontype": 1
}

PATCH/teamprojectautomations/{id} 200404

Update.

Requires scope projects:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
name	string(200)	Automation name.
triggertype	integer	What fires the automation: 0 = status changed, 1 = task assigned, 2 = due date reached, 3 = due date approaching, 4 = task created, 5 = milestone completed, 6 = priority changed.
triggervalue	text	Triggervalue. Stored as `text`, no practical length limit.
actiontype	integer	What the automation does: 0 = change status, 1 = reassign task, 2 = set priority, 3 = add tag, 4 = send notification, 5 = add comment.
actionvalue	text	Actionvalue. Stored as `text`, no practical length limit.
enabled	boolean	True while the automation is active.
sortorder	integer	Display order. Lower sorts first.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "name": "Example name",
    "triggertype": 1,
    "triggervalue": "Example triggervalue",
    "actiontype": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectautomations/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'teamprojectid' => 104,
    'teamproject' => 'Example teamproject',
    'name' => 'Example name',
    'triggertype' => 1,
    'triggervalue' => 'Example triggervalue',
    'actiontype' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "teamprojectid": 104,
        "teamproject": "Example teamproject",
        "name": "Example name",
        "triggertype": 1,
        "triggervalue": "Example triggervalue",
        "actiontype": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      teamprojectid: 104,
      teamproject: "Example teamproject",
      name: "Example name",
      triggertype: 1,
      triggervalue: "Example triggervalue",
      actiontype: 1,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    teamprojectid = 104,
    teamproject = "Example teamproject",
    name = "Example name",
    triggertype = 1,
    triggervalue = "Example triggervalue",
    actiontype = 1,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "name": "Example name",
    "triggertype": 1,
    "triggervalue": "Example triggervalue",
    "actiontype": 1
}

DELETE/teamprojectautomations/{id} 200404

Cancel.

Requires scope projects:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectautomations/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectautomations/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/teamprojectautomations/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "name": "Example name",
    "triggertype": 1,
    "triggervalue": "Example triggervalue",
    "actiontype": 1
}

Project templates →

Saved project templates.

Template items →

Milestones and tasks inside a template.