Skip to content

Latest commit

 

History

History
190 lines (155 loc) · 5.01 KB

journey.md

File metadata and controls

190 lines (155 loc) · 5.01 KB
page_title subcategory description
epilot-journey_journey Resource - terraform-provider-epilot-journey
Journey Resource

epilot-journey_journey (Resource)

Journey Resource

Example Usage

resource "epilot-journey_journey" "my_journey" {
  brand_id = "...my_brand_id..."
  context_schema = [
    {
      is_required        = true
      param_key          = "...my_param_key..."
      should_load_entity = false
      type               = "...my_type..."
    }
  ]
  design = {
    design_tokens = {
      # ...
    }
    logo_url = "...my_logo_url..."
    theme = {
      key = jsonencode("value"),
    }
  }
  journey_id = "...my_journey_id..."
  logics     = "{ \"see\": \"documentation\" }"
  manifest = [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
  name = "...my_name..."
  rules = [
    {
      source      = "...my_source..."
      source_type = "step"
      target      = "...my_target..."
      type        = "inject"
    }
  ]
  settings = {
    access_mode                  = "PUBLIC"
    address_suggestions_file_id  = "...my_address_suggestions_file_id..."
    address_suggestions_file_url = "...my_address_suggestions_file_url..."
    description                  = "...my_description..."
    design_id                    = "...my_design_id..."
    embed_options = {
      button = {
        align = "center"
        text  = "...my_text..."
      }
      lang          = "en"
      mode          = "inline"
      scroll_to_top = true
      top_bar       = true
      width         = "...my_width..."
    }
    entity_id = "...my_entity_id..."
    entity_tags = [
      "..."
    ]
    file_purposes = [
      "..."
    ]
    mappings_automation_id = "...my_mappings_automation_id..."
    runtime_entities = [
      "ORDER"
    ]
    safe_mode_automation = true
    targeted_customer    = "...my_targeted_customer..."
    template_id          = "...my_template_id..."
    third_party_cookies  = true
    use_new_design       = true
  }
  steps = "{ \"see\": \"documentation\" }"
}

Schema

Required

  • name (String)
  • steps (String) Parsed as JSON.

Optional

Nested Schema for context_schema

Optional:

  • is_required (Boolean)
  • param_key (String) Not Null
  • should_load_entity (Boolean)
  • type (String) Not Null

Nested Schema for design

Optional:

Nested Schema for design.design_tokens

Nested Schema for rules

Optional:

  • source (String) Not Null
  • source_type (String) Not Null; must be one of ["journey", "step", "block"]
  • target (String) Not Null
  • type (String) Not Null; must be one of ["inject", "injectWithKey"]

Nested Schema for settings

Optional:

  • access_mode (String) must be one of ["PUBLIC", "PRIVATE"]
  • address_suggestions_file_id (String)
  • address_suggestions_file_url (String) @deprecated Use addressSuggestionsFileId instead
  • description (String)
  • design_id (String)
  • embed_options (Attributes) (see below for nested schema)
  • entity_id (String)
  • entity_tags (List of String)
  • file_purposes (List of String)
  • mappings_automation_id (String)
  • runtime_entities (List of String)
  • safe_mode_automation (Boolean)
  • targeted_customer (String)
  • template_id (String)
  • third_party_cookies (Boolean) If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
  • use_new_design (Boolean)

Nested Schema for settings.embed_options

Optional:

  • button (Attributes) (see below for nested schema)
  • lang (String) must be one of ["de", "en", "fr"]
  • mode (String) must be one of ["full-screen", "inline"]
  • scroll_to_top (Boolean)
  • top_bar (Boolean)
  • width (String)

Nested Schema for settings.embed_options.button

Optional:

  • align (String) must be one of ["left", "center", "right"]
  • text (String)

Import

Import is supported using the following syntax:

terraform import epilot-journey_journey.my_epilot-journey_journey ""