For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integration Config

integration

relationship - required

Integration the config is bound to.

email_on_success

boolean - required

Determine wheter to send an email summary upon a successful integration run.

email_on_success_to_addresses

string - comma separated

Email addresses to receive summaries on successful integration completion.

email_on_failure

boolean - required

Determine wheter to send an email summary upon an integration failure.

email_on_failure_to_addresses

string - comma separated

Email addresses to receive summaries on integration failures.

email_digests

boolean - required

Enables a more detailed breakdown of the Integration Run for both the email_on_success and email_on_failure features.

store_run_history

boolean - required

Enables persistence of run histories for integrations. With this flag disabled the Integration Run History will not track run events.

store_run_history_for_x_days

integer

Number of days to keep Run Histories. After this date the runs are deleted permanently. Defaults to 730 days.

store_payload_in_run_history

boolean - required

Enables persistence of run history payloads for Integration Run Steps. The store_run_history must be enabled for this to be enabled.

store_payloads_in_run_history_for_x_days

integer

Number of days to persist Integration Run History Items. After this date run history payloads are deleted permanently. Defaults to 14 days.

retry_mode

string - required

The retry strategy for failed integration runs. Options: none (default), fixed (Fixed Interval), exponential (Exponential Backoff). See How to Configure Integration Retry for details.

retry_delay_seconds

integer - required

The initial delay in seconds before retrying a failed run. Range: 1–600. Default: 5.

retry_delay_jitter

integer - required

Randomness in seconds added to each retry delay to prevent thundering herd problems. Range: 0–120. Default: 2.

max_retries

integer - required

Maximum number of retry attempts for a failed run. Range: 1–10. Default: 3.

engine_version

Engine version used when running this integration.

Last updated

Was this helpful?