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
fullResynchronization booleanstring
falseWhether to do a full resynchronization
maxDuration string
PT5MdurationThe max total wait duration
options Non-dynamicHttpConfiguration
The HTTP client configuration.
wait booleanstring
trueWhether to wait for the end of the run.
Allowing to capture run status and logs
Outputs
runId integer
The runId of the sync created
Definitions
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeout string
durationThe time allowed to establish a connection to the server before failing.
readIdleTimeout string
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type *Requiredobject
password string
The password for HTTP basic authentication.
username string
The username for HTTP basic authentication.
java.nio.charset.Charset
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailed booleanstring
falseIf true, allow a failed response code (response code >= 400)
allowedResponseCodes array
List of response code allowed for this request
auth BasicAuthConfigurationBearerAuthConfiguration
The authentification to use.
defaultCharset Charsetstring
UTF-8The default charset for the request.
followRedirects booleanstring
trueWhether redirects should be followed automatically.
logs array
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
proxy ProxyConfiguration
The proxy configuration.
ssl SslOptions
The SSL request options
timeout TimeoutConfiguration
The timeout configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
address string
The address of the proxy server.
password string
The password for proxy authentication.
port integerstring
The port of the proxy server.
type string
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
username string
The username for proxy authentication.
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificates booleanstring
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.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type *Requiredobject
token string
The token for bearer token authentication.