Hightouch Sync

Hightouch Sync

Certified

Trigger and monitor a Hightouch sync

Triggers a Hightouch sync by ID. Waits for completion by default, polling every second until a terminal status or the 5 minute maxDuration. Set wait=false to return only the runId; set fullResynchronization=true to force a full reload.

yaml
type: io.kestra.plugin.hightouch.Sync

Run a Hightouch sync

yaml
id: hightouch_sync
namespace: company.team

tasks:
  - id: sync
    type: io.kestra.plugin.hightouch.Sync
    token: "{{ secret('HIGHTOUCH_API_TOKEN') }}"
    syncId: 1127166
Properties

Hightouch sync ID

Required numeric ID of the sync to trigger.

API Bearer token

Defaultfalse

Force full resynchronization

Default false. Sends fullResync=true so Hightouch reloads all rows instead of incremental changes.

DefaultPT5M

Maximum wait duration

Defaults to 5 minutes. Polls run status every second until a terminal state or this limit is reached.

The HTTP client configuration

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

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.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

Defaulttrue

Wait for run completion

Default true. When false the task returns the runId immediately without polling status, metrics, or logs.

Sync run metadata

Definitions
completionRatiointeger
createdAtstring
Formatdate-time
errorstring
failedRows
addedCountinteger
changedCountinteger
removedCountinteger
finishedAtstring
Formatdate-time
idinteger
plannedRows
addedCountinteger
changedCountinteger
removedCountinteger
querySizeinteger
startedAtstring
Formatdate-time
statusstring
Possible Values
PROCESSINGQUEUEDFAILEDCANCELLEDSUCCESSQUERYINGWARNINGREPORTINGINTERRUPTEDCOMPLETED_WITH_ERRORS
successfulRows
addedCountinteger
changedCountinteger
removedCountinteger

Hightouch run ID

Identifier returned by Hightouch for the triggered run.

The completion ratio of the Hightouch sync.

Number of rows failed to add.

Number of rows failed to change.

Number of rows failed to remove.

Number of rows successfully added.

Number of rows successfully changed.

Number of rows successfully removed.

More Plugins in this Category

Zulip
Zulip

Tasks that send messages to Zulip streams or users.

Business

2 tasks

3 blueprints

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks