Integration Config

integration

relationship - required

Integration this config is bound to.

email_on_success

boolean - required

Enable to send emails on successful Integration runs.

email_on_success_to_addresses

string - comma separated

Valid email addresses that will be sent emails based on successful integration completion.

email_on_failure

boolean - required

Enable to send emails unsuccessful Integration runs.

email_on_failure_to_addresses

string - comma separated

Valid email addresses that will be sent emails based on failed integration runs.

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.

engine_version

Engine version used when running this integration.

engine_version = "1.1.0"

Last updated

#178:

Change request updated