Update a trigger

curl --request PATCH \
  --url https://api.deck.co/v2/triggers/{trigger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "credential_ids": [
    "<string>"
  ],
  "credential_filter": {
    "source_ids": [
      "<string>"
    ],
    "status": [
      "<string>"
    ]
  },
  "input": "<unknown>",
  "skip_if": {
    "last_run": {
      "result": "<string>",
      "within_seconds": 123
    }
  },
  "concurrency_max": 123
}
'

import requests

url = "https://api.deck.co/v2/triggers/{trigger_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "credential_ids": ["<string>"],
    "credential_filter": {
        "source_ids": ["<string>"],
        "status": ["<string>"]
    },
    "input": "<unknown>",
    "skip_if": { "last_run": {
            "result": "<string>",
            "within_seconds": 123
        } },
    "concurrency_max": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    status: '<string>',
    credential_ids: ['<string>'],
    credential_filter: {source_ids: ['<string>'], status: ['<string>']},
    input: '<unknown>',
    skip_if: {last_run: {result: '<string>', within_seconds: 123}},
    concurrency_max: 123
  })
};

fetch('https://api.deck.co/v2/triggers/{trigger_id}', 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.deck.co/v2/triggers/{trigger_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'status' => '<string>',
    'credential_ids' => [
        '<string>'
    ],
    'credential_filter' => [
        'source_ids' => [
                '<string>'
        ],
        'status' => [
                '<string>'
        ]
    ],
    'input' => '<unknown>',
    'skip_if' => [
        'last_run' => [
                'result' => '<string>',
                'within_seconds' => 123
        ]
    ],
    'concurrency_max' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.deck.co/v2/triggers/{trigger_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"<string>\",\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"credential_filter\": {\n    \"source_ids\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ]\n  },\n  \"input\": \"<unknown>\",\n  \"skip_if\": {\n    \"last_run\": {\n      \"result\": \"<string>\",\n      \"within_seconds\": 123\n    }\n  },\n  \"concurrency_max\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

HttpResponse<String> response = Unirest.patch("https://api.deck.co/v2/triggers/{trigger_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"<string>\",\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"credential_filter\": {\n    \"source_ids\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ]\n  },\n  \"input\": \"<unknown>\",\n  \"skip_if\": {\n    \"last_run\": {\n      \"result\": \"<string>\",\n      \"within_seconds\": 123\n    }\n  },\n  \"concurrency_max\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.deck.co/v2/triggers/{trigger_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"<string>\",\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"credential_filter\": {\n    \"source_ids\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ]\n  },\n  \"input\": \"<unknown>\",\n  \"skip_if\": {\n    \"last_run\": {\n      \"result\": \"<string>\",\n      \"within_seconds\": 123\n    }\n  },\n  \"concurrency_max\": 123\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "condition": {
    "type": "<string>",
    "cron": "<string>",
    "timezone": "<string>"
  },
  "task_id": "<string>",
  "credential_ids": [
    "<string>"
  ],
  "credential_filter": {
    "source_ids": [
      "<string>"
    ],
    "status": [
      "<string>"
    ]
  },
  "input": "<unknown>",
  "skip_if": {
    "last_run": {
      "result": "<string>",
      "within_seconds": 123
    }
  },
  "concurrency_max": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

{
  "errors": {},
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "traceId": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

PATCH

triggers

{trigger_id}

Update a trigger

curl --request PATCH \
  --url https://api.deck.co/v2/triggers/{trigger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "credential_ids": [
    "<string>"
  ],
  "credential_filter": {
    "source_ids": [
      "<string>"
    ],
    "status": [
      "<string>"
    ]
  },
  "input": "<unknown>",
  "skip_if": {
    "last_run": {
      "result": "<string>",
      "within_seconds": 123
    }
  },
  "concurrency_max": 123
}
'

import requests

url = "https://api.deck.co/v2/triggers/{trigger_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "credential_ids": ["<string>"],
    "credential_filter": {
        "source_ids": ["<string>"],
        "status": ["<string>"]
    },
    "input": "<unknown>",
    "skip_if": { "last_run": {
            "result": "<string>",
            "within_seconds": 123
        } },
    "concurrency_max": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    status: '<string>',
    credential_ids: ['<string>'],
    credential_filter: {source_ids: ['<string>'], status: ['<string>']},
    input: '<unknown>',
    skip_if: {last_run: {result: '<string>', within_seconds: 123}},
    concurrency_max: 123
  })
};

fetch('https://api.deck.co/v2/triggers/{trigger_id}', 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.deck.co/v2/triggers/{trigger_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'status' => '<string>',
    'credential_ids' => [
        '<string>'
    ],
    'credential_filter' => [
        'source_ids' => [
                '<string>'
        ],
        'status' => [
                '<string>'
        ]
    ],
    'input' => '<unknown>',
    'skip_if' => [
        'last_run' => [
                'result' => '<string>',
                'within_seconds' => 123
        ]
    ],
    'concurrency_max' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.deck.co/v2/triggers/{trigger_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"<string>\",\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"credential_filter\": {\n    \"source_ids\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ]\n  },\n  \"input\": \"<unknown>\",\n  \"skip_if\": {\n    \"last_run\": {\n      \"result\": \"<string>\",\n      \"within_seconds\": 123\n    }\n  },\n  \"concurrency_max\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

HttpResponse<String> response = Unirest.patch("https://api.deck.co/v2/triggers/{trigger_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"<string>\",\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"credential_filter\": {\n    \"source_ids\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ]\n  },\n  \"input\": \"<unknown>\",\n  \"skip_if\": {\n    \"last_run\": {\n      \"result\": \"<string>\",\n      \"within_seconds\": 123\n    }\n  },\n  \"concurrency_max\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.deck.co/v2/triggers/{trigger_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"<string>\",\n  \"credential_ids\": [\n    \"<string>\"\n  ],\n  \"credential_filter\": {\n    \"source_ids\": [\n      \"<string>\"\n    ],\n    \"status\": [\n      \"<string>\"\n    ]\n  },\n  \"input\": \"<unknown>\",\n  \"skip_if\": {\n    \"last_run\": {\n      \"result\": \"<string>\",\n      \"within_seconds\": 123\n    }\n  },\n  \"concurrency_max\": 123\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "condition": {
    "type": "<string>",
    "cron": "<string>",
    "timezone": "<string>"
  },
  "task_id": "<string>",
  "credential_ids": [
    "<string>"
  ],
  "credential_filter": {
    "source_ids": [
      "<string>"
    ],
    "status": [
      "<string>"
    ]
  },
  "input": "<unknown>",
  "skip_if": {
    "last_run": {
      "result": "<string>",
      "within_seconds": 123
    }
  },
  "concurrency_max": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

{
  "errors": {},
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "traceId": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "errors": [
    {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Secret key (sk_live_...)

Path Parameters

trigger_id

string

required

Unique identifier for the trigger (prefixed with trg_).

Body

All fields are optional; omitted fields are left unchanged. The trigger's target task cannot be changed.

name

string

Display name for the trigger.

description

null | string

Description of the trigger's purpose. null clears it.

status

string

active or inactive. Setting this is how you pause and resume a trigger.

condition

object

When the trigger fires: a cron expression evaluated in a timezone.

Show child attributes

credential_ids

null | string[]

Explicit credentials to target. Replaces the existing list wholesale.

credential_filter

null | object

A scope of credentials to fan out across.

Show child attributes

input

null | any

Input passed to every run this trigger creates, validated against the task's input_schema.

skip_if

null | object

Skip condition evaluated per credential. null clears it.

Show child attributes

concurrency_max

Maximum simultaneous runs from this trigger. null removes the cap.

Response

A trigger object. Triggers create task runs on a schedule across a set of credentials.

string

required

Unique identifier for the trigger, prefixed with trg_.

object

string

required

Always trigger.

name

string

required

Display name for the trigger.

description

null | string

required

Description of the trigger's purpose.

status

string

required

active or inactive. Inactive triggers keep their configuration and fire nothing.

condition

object

required

When the trigger fires: a cron expression evaluated in a timezone.

Show child attributes

task_id

string

required

The task this trigger runs. Prefixed with task_. Fixed at creation.

credential_ids

null | string[]

required

Explicit credentials the trigger targets. null when the trigger uses credential_filter.

credential_filter

null | object

required

Credential scope the trigger fans out across. null when the trigger uses credential_ids.

Show child attributes

input

null | any

required

Input passed to every run this trigger creates, matching the task's input_schema.

skip_if

null | object

required

Skip condition evaluated per credential before a run is created.

Show child attributes

concurrency_max

required

Maximum simultaneous runs from this trigger. null means no per-trigger cap.

created_at

string<date-time>

required

ISO 8601 timestamp of when the resource was created.

updated_at

string<date-time>

required

ISO 8601 timestamp of when the resource was last updated.

request_id

string

required

Unique identifier for the API request. Include this when contacting support.

Retrieve a trigger Delete a trigger

Agents

Sources

Tasks

Task Runs

Credentials

Sessions

Storage

Triggers

Event Destinations

Events

Components

Test

Update a trigger

Authorizations

Path Parameters

Body

Response