Triggers

List triggers

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
is_activeany ofOptional
booleanOptional
or
nullOptional
limitinteger · max: 20OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
chevron-right
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenany ofOptional
integerOptional
or
nullOptional
totalany ofOptional
integerOptional
or
nullOptional
get
/v1/{workspace_id}/triggers

Create a trigger

post
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
namestring · min: 1 · max: 256Required
descriptionany ofOptional
string · max: 2000Optional
or
nullOptional
event_typestring · min: 1 · max: 128RequiredPattern: ^[a-zA-Z0-9._\-:*]+$
event_filterany ofOptional
or
nullOptional
action_idstring · uuidRequired
scheduleany ofOptional
string · min: 1 · max: 128Optional
or
nullOptional
timezonestring · min: 1 · max: 64OptionalDefault: UTC
Responses
post
/v1/{workspace_id}/triggers

Get a trigger

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired

Trigger display name

descriptionany ofOptional

Human-readable description

stringOptional
or
nullOptional
event_typestringRequired

Event type pattern to match

event_filterany ofOptional

JSONPath filter on event data

or
nullOptional
action_idstring · uuidRequired

Action (skill) to invoke when fired

scheduleany ofOptional

Cron schedule expression (e.g. '0 9 * * 1-5')

stringOptional
or
nullOptional
timezonestringRequired

IANA timezone for schedule evaluation

next_fire_atany ofOptional

Next scheduled fire time

string · date-timeOptional
or
nullOptional
is_activebooleanRequired

Whether the trigger is active

created_byany ofOptional

Entity ID of the creator

stringOptional
or
nullOptional
created_atany ofOptional

When the trigger was created

string · date-timeOptional
or
nullOptional
updated_atany ofOptional

When the trigger was last updated

string · date-timeOptional
or
nullOptional
get
/v1/{workspace_id}/triggers/{trigger_id}

Update a trigger

put
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Body
nameany ofOptional
string · min: 1 · max: 256Optional
or
nullOptional
descriptionany ofOptional
string · max: 2000Optional
or
nullOptional
event_typeany ofOptional
string · min: 1 · max: 128OptionalPattern: ^[a-zA-Z0-9._\-:*]+$
or
nullOptional
event_filterany ofOptional
or
nullOptional
action_idany ofOptional
string · uuidOptional
or
nullOptional
input_templateany ofOptional
or
nullOptional
scheduleany ofOptional
string · min: 1 · max: 128Optional
or
nullOptional
timezoneany ofOptional
string · min: 1 · max: 64Optional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired

Trigger display name

descriptionany ofOptional

Human-readable description

stringOptional
or
nullOptional
event_typestringRequired

Event type pattern to match

event_filterany ofOptional

JSONPath filter on event data

or
nullOptional
action_idstring · uuidRequired

Action (skill) to invoke when fired

scheduleany ofOptional

Cron schedule expression (e.g. '0 9 * * 1-5')

stringOptional
or
nullOptional
timezonestringRequired

IANA timezone for schedule evaluation

next_fire_atany ofOptional

Next scheduled fire time

string · date-timeOptional
or
nullOptional
is_activebooleanRequired

Whether the trigger is active

created_byany ofOptional

Entity ID of the creator

stringOptional
or
nullOptional
created_atany ofOptional

When the trigger was created

string · date-timeOptional
or
nullOptional
updated_atany ofOptional

When the trigger was last updated

string · date-timeOptional
or
nullOptional
put
/v1/{workspace_id}/triggers/{trigger_id}

Delete a trigger

delete
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Responses
delete
/v1/{workspace_id}/triggers/{trigger_id}

No content

Pause a trigger

post
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired

Trigger display name

descriptionany ofOptional

Human-readable description

stringOptional
or
nullOptional
event_typestringRequired

Event type pattern to match

event_filterany ofOptional

JSONPath filter on event data

or
nullOptional
action_idstring · uuidRequired

Action (skill) to invoke when fired

scheduleany ofOptional

Cron schedule expression (e.g. '0 9 * * 1-5')

stringOptional
or
nullOptional
timezonestringRequired

IANA timezone for schedule evaluation

next_fire_atany ofOptional

Next scheduled fire time

string · date-timeOptional
or
nullOptional
is_activebooleanRequired

Whether the trigger is active

created_byany ofOptional

Entity ID of the creator

stringOptional
or
nullOptional
created_atany ofOptional

When the trigger was created

string · date-timeOptional
or
nullOptional
updated_atany ofOptional

When the trigger was last updated

string · date-timeOptional
or
nullOptional
post
/v1/{workspace_id}/triggers/{trigger_id}/pause

Resume a trigger

post
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired

Trigger display name

descriptionany ofOptional

Human-readable description

stringOptional
or
nullOptional
event_typestringRequired

Event type pattern to match

event_filterany ofOptional

JSONPath filter on event data

or
nullOptional
action_idstring · uuidRequired

Action (skill) to invoke when fired

scheduleany ofOptional

Cron schedule expression (e.g. '0 9 * * 1-5')

stringOptional
or
nullOptional
timezonestringRequired

IANA timezone for schedule evaluation

next_fire_atany ofOptional

Next scheduled fire time

string · date-timeOptional
or
nullOptional
is_activebooleanRequired

Whether the trigger is active

created_byany ofOptional

Entity ID of the creator

stringOptional
or
nullOptional
created_atany ofOptional

When the trigger was created

string · date-timeOptional
or
nullOptional
updated_atany ofOptional

When the trigger was last updated

string · date-timeOptional
or
nullOptional
post
/v1/{workspace_id}/triggers/{trigger_id}/resume

Manually fire a trigger now

post
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Body
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
fired_event_idstring · uuidRequired
trigger_idstring · uuidRequired
statusconst: firedOptionalDefault: fired
post
/v1/{workspace_id}/triggers/{trigger_id}/fire

List trigger execution history

get

Execution history from the Lakebase entity-event timeline read model.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
trigger_idstring · uuidRequired
Query parameters
limitinteger · max: 20OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
chevron-right
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenany ofOptional
integerOptional
or
nullOptional
totalany ofOptional
integerOptional
or
nullOptional
get
/v1/{workspace_id}/triggers/{trigger_id}/runs

Last updated

Was this helpful?