Get trigger by id

Access control

Restricted tokens need the API scope api.everything_else

GET/v1/triggers/id/{trigger_id}

Authorization

AuthorizationBearer token · headerrequired

Path parameters

trigger_idstringrequired

Header parameters

X-Roboto-Org-Idstring

X-Roboto-User-Idstring

Responses

200

dataobjectrequired

Wire-transmissible representation of a trigger.

A firing source (a platform event subscription or a schedule), an optional condition over the firing's namespace, and the targets to dispatch on a match. Cross-field rules — exposed roots, once_per legality, template placeholders — are enforced when the trigger is saved, by :class:~roboto.domain.triggers.TriggerValidator.

Triggered work runs as the organization's actions service user; a trigger cannot run its targets as anyone else.

Show properties

trigger_idstringrequired

org_idstringrequired

namestringrequired

enabledboolean

default: true

fires_onEventSubscription | Schedulerequired

Show properties

One of:

EventSubscription

typestring

default: "events"

eventsPlatformEventType[]required

once_perOncePerrequired

A grain an event offers for deduplication: the occurrence itself, or an entity the event names.

This is an event's vocabulary, not a trigger's. Each :class:~roboto.domain.platform_events.PlatformEventType declares the grains it supports, and how an occurrence projects onto each, in its :class:~roboto.domain.platform_events.PlatformEventDescriptor; that projection is what turns one occurrence into one idempotency token. A trigger only chooses among the grains its events offer, and its choice must be legal for every event type it subscribes to.

Allowed:occurrencefiledatasetinvocationevent

Schedule

typestring

default: "schedule"

cronstringrequired

conditionCondition | ConditionGroup | null

default: null

Show properties

Any of:

Condition

fieldstringrequired

comparatorComparatorrequired

The comparator to use when comparing a field to a value.

Allowed:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALCONTAINSNOT_CONTAINSIS_NULLIS_NOT_NULLEXISTSNOT_EXISTSBEGINS_WITHLIKENOT_LIKE

default: null

Show properties

Any of:

string

string

boolean

boolean

integer

integer

number

number

string

string

string<date-time>

string<date-time>

null

null

ConditionGroup

operatorConditionOperatorrequired

The operator to use when combining multiple conditions.

Allowed:ANDORNOT

conditionsCondition | ConditionGroup[]required

Show properties

Array of Condition | ConditionGroup

Any of:

Condition

fieldstringrequired

comparatorComparatorrequired

The comparator to use when comparing a field to a value.

Allowed:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALCONTAINSNOT_CONTAINSIS_NULLIS_NOT_NULLEXISTSNOT_EXISTSBEGINS_WITHLIKENOT_LIKE

default: null

Show properties

Any of:

string

string

boolean

boolean

integer

integer

number

number

string

string

string<date-time>

string<date-time>

null

null

ConditionGroup

Circular reference to ConditionGroup.

null

null

targetsInvokeActionTarget | StartAgentTarget | SendSlackMessageTarget[]required

Show properties

Array of InvokeActionTarget | StartAgentTarget | SendSlackMessageTarget

One of:

InvokeActionTarget

actionActionReferencerequired

Qualified action reference.

Show properties

namestringrequired

digeststring | null

default: null

Show properties

Any of:

string

string

null

null

ownerstring | null

default: null

Show properties

Any of:

string

string

null

null

invocation_inputInvocationInput | null

default: null

Show properties

Any of:

InvocationInput

filesFileSelector | FileSelector[] | null

default: null

Show properties

Any of:

FileSelector

querystring | null

default: null

Show properties

Any of:

string

string

null

null

idsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

namesstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

dataset_idstring | null

default: null

Show properties

Any of:

string

string

null

null

pathsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

FileSelector[]

Array of FileSelector

querystring | null

default: null

Show properties

Any of:

string

string

null

null

idsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

namesstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

dataset_idstring | null

default: null

Show properties

Any of:

string

string

null

null

pathsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

null

null

sessionsDataSelector | DataSelector[] | null

default: null

Show properties

Any of:

DataSelector

querystring | null

default: null

Show properties

Any of:

string

string

null

null

idsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

namesstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

dataset_idstring | null

default: null

Show properties

Any of:

string

string

null

null

DataSelector[]

Array of DataSelector

querystring | null

default: null

Show properties

Any of:

string

string

null

null

idsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

namesstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

dataset_idstring | null

default: null

Show properties

Any of:

string

string

null

null

null

null

topicsDataSelector | DataSelector[] | null

default: null

Show properties

Any of:

DataSelector

querystring | null

default: null

Show properties

Any of:

string

string

null

null

idsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

namesstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

dataset_idstring | null

default: null

Show properties

Any of:

string

string

null

null

DataSelector[]

Array of DataSelector

querystring | null

default: null

Show properties

Any of:

string

string

null

null

idsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

namesstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

dataset_idstring | null

default: null

Show properties

Any of:

string

string

null

null

null

null

null

null

parameter_valuesobject

compute_requirement_overridesComputeRequirements | null

default: null

Show properties

Any of:

ComputeRequirements

vCPUinteger

default: 512

memory_MiBinteger

default: 1024

gpuboolean

default: false

storage_GiBinteger

default: 21

null

null

container_parameter_overridesContainerParameters | null

default: null

Show properties

Any of:

ContainerParameters

commandstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

entry_pointstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

env_varsobject | null

default: null

Show properties

Any of:

object

object

null

null

workdirstring | null

default: null

Show properties

Any of:

string

string

null

null

null

null

timeoutinteger | null

default: null

Show properties

Any of:

integer

integer

null

null

upload_destinationInvocationUploadDestination | null

default: null

Show properties

Any of:

InvocationUploadDestination

destination_typeUploadDestinationType

Type of upload destination for invocation outputs.

Defines where files generated by action invocations should be uploaded. Currently supports datasets as the primary destination type.

Allowed:DatasetUnknown

destination_idstring | null

default: null

Show properties

Any of:

string

string

null

null

null

null

typestring

default: "invoke_action"

target_idstringrequired

required_inputsstring[]

additional_inputsstring[] | null

default: null

Show properties

Any of:

string[]

Array of string

string

null

null

StartAgentTarget

typestring

default: "start_agent"

target_idstringrequired

agent_idstringrequired

valuesobject

visibilityThreadVisibility

Read-scope for an :class:AgentThreadRecord.

Set when the thread is created, and changed afterwards only by the thread's creator, via :meth:roboto.ai.agent_thread.AgentThread.set_visibility (POST /v1/ai/threads/<thread_id>/visibility). Roboto admins read every thread but cannot re-scope one they did not create.

Import as :class:roboto.ai.agent_thread.ThreadVisibility.

Allowed:privateorg

analysis_scopeAnalysisScope | null

default: null

Show properties

Any of:

AnalysisScope

start_timeinteger | null

default: null

Show properties

Any of:

integer

integer

null

null

end_timeinteger | null

default: null

Show properties

Any of:

integer

integer

null

null

null

null

SendSlackMessageTarget

typestring

default: "send_slack_message"

target_idstringrequired

channel_idstringrequired

textstringrequired

enginestring

default: "v1"

managed_byManagedBy | null

default: null

Show properties

Any of:

ManagedBy

kindManagedByKindrequired

What kind of thing in Roboto manages a trigger.

Allowed:systemingestion_rule

idstringrequired

null

null

createdstring<date-time>required

created_bystringrequired

modifiedstring<date-time>required

modified_bystringrequired

400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

401

Thrown when authentication fails

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

403

Thrown if an operation would exceed a user or org level limit.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

410

Thrown if a resource is missing or expired.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

501

Thrown by shimmed out APIs which have not yet been implemented

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

X-Roboto-Org-IdheaderX-Roboto-User-Idheadertrigger_idpath*

Request

curl -X GET 'https://api.roboto.ai/v1/triggers/id/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.roboto.ai/v1/triggers/id/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.roboto.ai/v1/triggers/id/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": {
    "trigger_id": "string",
    "org_id": "string",
    "name": "string",
    "enabled": true,
    "fires_on": {
      "type": "events",
      "events": [
        "file.uploaded"
      ],
      "once_per": "occurrence"
    },
    "condition": null,
    "targets": [
      {
        "action": {
          "name": "string",
          "digest": null,
          "owner": null
        },
        "invocation_input": null,
        "parameter_values": {},
        "compute_requirement_overrides": null,
        "container_parameter_overrides": null,
        "timeout": null,
        "upload_destination": null,
        "type": "invoke_action",
        "target_id": "string",
        "required_inputs": [
          "string"
        ],
        "additional_inputs": null
      }
    ],
    "engine": "v1",
    "managed_by": null,
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}