Skip to content

client.event_triggers

client.event_triggers — the eventTriggers operations.

On AsyncKindgi every method is the same, awaited.

list(
*,
limit: int | None = None,
cursor: str | None = None,
status: Literal['active', 'paused'] | None = None,
timeout: float | None = None,
) -> EventTriggerCollectionPage

List event triggers. GET /v1/event-triggers

register(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> EventTriggerRecord

Register an event trigger. POST /v1/event-triggers

Registers a kind=event trigger. The event-trigger scheduler in the runtime subscribes on the deployment event bus for the given eventKind; matching events start a flow run.

get(*, timeout: float | None = None) -> EventTriggerRecord

Fetch an event trigger. GET /v1/event-triggers/{triggerId}

update(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> EventTriggerRecord

Update an event trigger. PATCH /v1/event-triggers/{triggerId}

pause(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
) -> EventTriggerRecord

Pause an event trigger. POST /v1/event-triggers/{triggerId}/pause

resume(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
) -> EventTriggerRecord

Resume an event trigger. POST /v1/event-triggers/{triggerId}/resume

unregister(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
) -> EventTriggerUnregisterResult

Soft-delete an event trigger (tombstone). POST /v1/event-triggers/{triggerId}/unregister