highbond_event (Resource)

Example Usage

resource "highbond_event" "main" {
  admin_name    = "VRM: submit request review"
  display_name  = "Submit request for review"
  description   = "Description of the event."
  type          = "button"
  position      = 1
  shared        = false
  force_updates = true // Create only with force update changes
  handlers {
    id       = highbond_handler.main.id
    scopes   = ["self"]
    position = 1
  }
  triggers {
    type                = "questionnaireResponded"
    questionnaire_ids   = [highbond_questionnaire.main.id]
    trigger_conjunction = "anyOf"
  }
  triggers {
    type                = "fieldUpdated"
    field_names         = [highbond_attribute_type.text.field_name]
    trigger_conjunction = "anyOf"
  }
}

Schema

Required

• admin_name (String) The name of the event. This field is case-insensitive unique
• position (Number) Each event is shown as a button in UI; this attribute determines the order of the button displayed among other events for statuses
• type (String) Configures the type of the event. It controls the appearance of interactable UI element for this event. Possible Enum values: buttton, overflow, hidden

Optional

• description (String) The description of the event
• display_name (String) The display name of the event
• force_updates (Boolean) Allows overriding top-level 'create_only' option.
• handlers (Block List) List of handlers (see below for nested schema)
• invocation_context (Block Set) The context information to invoke the event (see below for nested schema)
• shared (Boolean) Events can be marked as shared. Only shared events can be reused across multiple workflows
• triggers (Block List) List of triggers (see below for nested schema)

Read-Only

• created_at (String) The date the event was created
• id (String) The ID of this resource.
• updated_at (String) The date the event was updated

Nested Schema for handlers

Required:

• id (String) The ID of the handler

Optional:

• position (Number) The order in which the handler will be executed when an event is invoked
• scopes (List of String) The relationship of the handler to the scope of the event

Nested Schema for invocation_context

Optional:

• context (Block Set) The invocation context information of the handler (see below for nested schema)
• handler_id (String) The ID of the handler

Nested Schema for invocation_context.context

Optional:

• context (Block Set) The invocation context information of the condition/action (see below for nested schema)
• handler_action_type (String) Type of the condition (only available when it is a condition)
• handler_condition_type (String) Type of the condition (only available when it is a condition)

Nested Schema for invocation_context.context.context

Optional:

• data_type (String) string
• key (String) Key of the context

Nested Schema for triggers

Required:

• type (String) The trigger type of the event. Only one instance of a given triggerType is allowed in the triggers array. Enum: fieldUpdated questionnaireResponded

Optional:

• field_names (List of String) The field names of an attribute that, when updated, will trigger the event. Required by the fieldUpdated trigger_type
• questionnaire_ids (List of String) The questionnaire ids that trigger the handler. Required by the questionnaireResponded trigger_type
• trigger_conjunction (String) The conjunction used when performing the trigger check. Required by the fieldUpdated trigger_type, which supports both anyOf and allOf. For other trigger types, anyOf is implicitly used.Enum: anyOf, allOf