Trigger CdcTrigger
CertifiedTrigger based on QuickBooks Change Data Capture (CDC)
Trigger CdcTrigger
Trigger based on QuickBooks Change Data Capture (CDC)
Periodically polls QuickBooks to fetch changed entities since the last successful poll.
type: io.kestra.plugin.quickbooks.trigger.CdcTriggerExamples
Trigger a flow when QuickBooks entities change
id: quickbooks_cdc_trigger
namespace: company.team
triggers:
- id: watch_invoices
type: io.kestra.plugin.quickbooks.trigger.CdcTrigger
clientId: "{{ secret('QBO_CLIENT_ID') }}"
clientSecret: "{{ secret('QBO_CLIENT_SECRET') }}"
refreshToken: "{{ secret('QBO_REFRESH_TOKEN') }}"
realmId: "{{ secret('QBO_REALM_ID') }}"
entities:
- Invoice
- Customer
interval: "PT1H"
tasks:
- id: process_changes
type: io.kestra.plugin.core.log.Log
message: "CDC Output: {{ trigger.cdcResponse }}"
Properties
clientId *string
QuickBooks Client ID
clientSecret *string
QuickBooks Client Secret
entities *array
Entities
A list of QuickBooks entities to check for changes (e.g., 'Invoice', 'Customer').
realmId *string
QuickBooks Realm ID
refreshToken *string
QuickBooks Refresh Token
allowConcurrent boolean
falseSpecifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.
authUrl string
https://oauth.platform.intuit.com/oauth2/v1/tokens/bearerOAuth Token URL
The OAuth2 token endpoint. Must be an intuit.com domain.
baseUrl string
https://quickbooks.api.intuit.comBase URL
The Base URL for QuickBooks API. Must be an intuit.com domain. Defaults to production.
interval string
PT15MdurationPolling interval
How often the trigger should poll for changes.
minorVersion integerstring
75Minor Version
The minor version of the QuickBooks API to use. Must be 1 or more, checked after rendering.
stopAfter array
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of execution states after which a trigger should be stopped (a.k.a. disabled).
when string
trueA condition that determines whether the trigger should run.
A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.
Outputs
cdcResponse object
CDC response
The parsed JSON response of QuickBooks with the full changed records.
rows object
Changed rows per entity
Maps each requested entity to its changed records. Every record has id, status (Created, Updated or Deleted) and deleted. An entity without changes maps to an empty list.
