Sync
Trigger a Hightouch sync and wait for its completion.
Trigger a Hightouch sync and wait for its completion.
Trigger a Hightouch sync and wait for its completion.
type: "io.kestra.plugin.hightouch.Sync"Examples
Run a Hightouch sync
id: hightouch_sync
namespace: company.team
tasks:
- id: sync
type: io.kestra.plugin.hightouch.Sync
token: "{{ secret('HIGHTOUCH_API_TOKEN') }}"
syncId: 1127166
Properties
syncId*Requiredintegerstring
The sync id to trigger run
token*Requiredstring
API Bearer token
fullResynchronizationbooleanstring
falseWhether to do a full resynchronization
maxDurationstring
PT5MdurationThe max total wait duration
optionsNon-dynamic
The HTTP client configuration.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentification to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationdurationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
DIRECTDIRECTHTTPSOCKSThe address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationdurationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
durationThe time allowed to establish a connection to the server before failing.
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
waitbooleanstring
trueWhether to wait for the end of the run.
Allowing to capture run status and logs
Outputs
runIdinteger
The runId of the sync created
Metrics
completion.ratiocounter
The completion ratio of the Hightouch sync.
rows.failed.addedcounter
Number of rows failed to add.
rows.failed.changedcounter
Number of rows failed to change.
rows.failed.removedcounter
Number of rows failed to remove.
rows.successfully.addedcounter
Number of rows successfully added.
rows.successfully.changedcounter
Number of rows successfully changed.
rows.successfully.removedcounter
Number of rows successfully removed.
