Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview

Get trigger dispatches

Access control

  • Restricted tokens need the API scope api.everything_else
GET/v1/triggers/id/{trigger_id}/dispatches
Authorization
AuthorizationBearer token · headerrequired
Path parameters
trigger_idstringrequired
Query parameters
limitnumber
page_tokenstring
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Responses
200

OK

dataobjectrequired
Show properties
itemsTriggerDispatchRecord[]required
Show properties
Array of TriggerDispatchRecord
trigger_idstringrequired
idempotency_tokenstringrequired
target_idstringrequired
org_idstringrequired
target_typeTriggerTargetTyperequired

The kind of thing a trigger does when it fires.

Allowed:invoke_actionstart_agentsend_slack_message
event_typePlatformEventTyperequired

A thing that happens on the platform that triggers can subscribe to.

Every member has a :class:~roboto.domain.platform_events.PlatformEventDescriptor in the default :class:~roboto.domain.platform_events.PlatformEventCatalog describing its payload model, the namespace roots it exposes to conditions and templates, and the :class:~roboto.domain.platform_events.OncePer values it supports.

Allowed:file.uploadeddataset.upload_completedfile.ingestedfile.metadata_updateddataset.metadata_updateddataset.createddataset.tag_addedinvocation.completedinvocation.failedsession.ingestedevent.createdschedule.fired
event_idstringrequired
subjectstringrequired
dataset_idstring | null
default: null
Show properties
Any of:
string
string
null
null
statusTriggerDispatchStatusrequired

Lifecycle state of one dispatch: one attempt to run one target for one matched event.

Allowed:claimeddispatchedfailedunknown
status_detailstring | null
default: null
Show properties
Any of:
string
string
null
null
result_refstring | null
default: null
Show properties
Any of:
string
string
null
null
claimed_atstring<date-time>required
finalized_atstring<date-time> | null
default: null
Show properties
Any of:
string<date-time>
string<date-time>
null
null
next_tokenstring | null
default: null
Show properties
Any of:
string
string
null
null
total_countinteger | null
default: null
Show properties
Any of:
integer
integer
null
null
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
Authorization
Parameters
Request
curl -X GET 'https://api.roboto.ai/v1/triggers/id/string/dispatches' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": {
    "items": [
      {
        "trigger_id": "string",
        "idempotency_token": "string",
        "target_id": "string",
        "org_id": "string",
        "target_type": "invoke_action",
        "event_type": "file.uploaded",
        "event_id": "string",
        "subject": "string",
        "dataset_id": null,
        "status": "claimed",
        "status_detail": null,
        "result_ref": null,
        "claimed_at": "2019-08-24T14:15:22Z",
        "finalized_at": null
      }
    ],
    "next_token": null,
    "total_count": null
  }
}