triggers.getTrigger

GET

/v1/triggers/{triggerId}

const url = 'https://example.com/v1/triggers/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

token
session

Parameters

Path Parameters

triggerId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

required

string

>= 1 characters <= 128 characters

owner

required

Any of:

object
object

object

_tag

required

string

Allowed values: Member

userId

required

string

bot

required

string

>= 1 characters <= 128 characters

prompt

required

string

schedule

required

Any of:

object
null

object

cron

required

string

>= 1 characters <= 200 characters

timeZone

string

<= 100 characters

webhook

required

boolean

actor

required

string

enabled

required

boolean

needsAuthorization

required

boolean

nextRunAt

required

Any of:

number
null

number

executionId

required

Any of:

string
null

string

>= 1 characters <= 128 characters

lastFiredAt

required

Any of:

number
null

number

revision

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "owner": {
    "_tag": "Member"
  }
}

400

TriggerInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: TriggerInvalid

message

required

string

Example

{
  "_tag": "TriggerInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

TriggerNotFound

application/json

object

_tag

required

string

Allowed values: TriggerNotFound

required

string

Example

{
  "_tag": "TriggerNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | TriggerConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}