Skip to main content
PATCH
Update trigger

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

triggerId
string
required

The ti_ public id of the trigger instance.

Body

application/json

The fields to change. Omitted fields are left alone.

The wire body of PATCH /v1/triggers/{triggerId}. Every field is optional; an omitted field is left alone rather than cleared.

connection_id
integer<int32> | null

The connection to re-point at. Supply this or ConnectionName; omit both to leave the current connection alone.

connection_name
string | null

The connection's name, for callers that never see ids. Same account-scoped resolution as ConnectionName.

config
unknown
schedule
object | null

The schedule parameter block: how often a polling trigger runs, plus the weekdays and time-of-day window it may run in. Polling triggers only; rejected on any other kind.

poll_interval_minutes
integer<int32> | null
listen_columns
string[] | null
destination_id
integer<int32> | null
dedupe_window_hours
integer<int32> | null

Response

The updated trigger instance.

A trigger instance as the API returns it. status is derived on every read, so it reflects whether the trigger is really capturing right now rather than what was last written.

kind
enum<string>
required

D6's discriminator. Always api here; ?include=workflow is what emits workflow.

Available options:
api,
workflow
status
enum<string>
required

Derived from the hidden workflow, never read from the stored column.

Available options:
enabled,
disabled,
errored
id
string
trigger_slug
string | null
connection_id
integer<int32>
activity_id
integer<int32>
destination_id
integer<int32> | null
dedupe_window_hours
integer<int32>
status_reason
enum<string> | null

Why the instance is errored. Null whenever the instance is not blocked - see TriggerStatusReason for the frozen vocabulary and the derivation ORDER.

Available options:
max_consecutive_failures,
activity_limit,
manual,
subscribe_failed,
connection_deleted,
trigger_type_removed
blocked_since
string<date-time> | null

When the block landed. Null whenever the instance is not blocked.

last_event_at
string<date-time> | null
last_error_at
string<date-time> | null
last_error
string | null

Bounded and credential-scrubbed at the point of writing - see TriggerInstance.LastError.

next_run_at
string<date-time> | null

When the polling scheduler will next select this trigger. Null for push and manual-webhook flavours.

subscription_count
integer<int32>

How many subscriptions this trigger holds with the provider. Not always 1: a subscription covers a single listen column, so N listen_columns create N subscriptions - and providers usually meter them.

created_at
string<date-time>
config
any | null

The trigger activity's own inputs, as supplied on create/patch.

schedule
object | null

Present only for polling triggers. Carries effective - see TriggerScheduleEffectiveDTO.

listen_columns
string[] | null

Present only for push triggers that declare IsShowFilterChanges.

webhook_url
string | null

Where a manual_webhook trigger's caller must POST events - the only delivery flavour with no provider subscription, so without this the caller has no way to learn the endpoint (design spec §6, folded in from the §6b UI plan). Null for every other delivery flavour, and null even for a manual-webhook instance whose step-1 ActivityToken has never been persisted - see TriggerInstanceService.EnrichAsync for why that gate exists.