Skip to content
OpenBot

triggers.listTriggers

GET
/v1/triggers
curl --request GET \
  --url https://example.com/v1/triggers \
  --header 'Authorization: Bearer <token>'

Lists the triggers that the caller can read: their own and the shared ones.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
id
required
string
>= 1 characters <= 128 characters
owner
required
Any of:
object
_tag
required
string
Allowed values: Member
userId
required
string
agent
required
string
>= 1 characters <= 128 characters
prompt
required
string
schedule
required
Any of:
object
cron
required
string
>= 1 characters <= 200 characters
timeZone
string
<= 100 characters
webhook
required
boolean
actor
required
string
enabled
required
boolean
nextRunAt
required
Any of:
number
lastFiredAt
required
Any of:
number
revision
required
integer
<= 9007199254740991
createdAt
required
number
updatedAt
required
number

Example 

[
  {
    "owner": {
      "_tag": "Member"
    }
  }
]

400

Section titled “400”

TriggerInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: TriggerInvalid
message
required
string

Example 

{
  "_tag": "TriggerInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

TriggerNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: TriggerNotFound
id
required
string

Example 

{
  "_tag": "TriggerNotFound"
}

409

Section titled “409”

TriggerConflict

Media typeapplication/json
object
_tag
required
string
Allowed values: TriggerConflict
message
required
string

Example 

{
  "_tag": "TriggerConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

AuthorizationUnavailable | TriggerStorageUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}