Skip to main content
Version: Latest Version (2.9.2)

highbond_event (Resource)

Schema

Required

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

Optional

descriptionString The description of the event
display_nameString The display name of the event
force_updatesBoolean Allows overriding top-level 'create_only' option.
handlersBlock List List of handlers
Nested Schema for `handlers`

Required

idString The ID of the handler

Optional

positionNumber The order in which the handler will be executed when an event is invoked
scopesList of String The relationship of the handler to the scope of the event
idString The ID of this resource.
invocation_contextBlock Set The context information to invoke the event
Nested Schema for `invocation_context`

Optional

contextBlock Set The invocation context information of the handler
Nested Schema for `invocation_context.context`

Optional

contextBlock Set The invocation context information of the condition/action
Nested Schema for `invocation_context.context.context`

Optional

data_typeString string
keyString Key of the context
handler_action_typeString Type of the condition (only available when it is a condition)
handler_condition_typeString Type of the condition (only available when it is a condition)
handler_idString The ID of the handler
sharedBoolean Events can be marked as shared. Only shared events can be reused across multiple workflows
triggersBlock List List of triggers
Nested Schema for `triggers`

Required

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

Optional

field_namesList of String The field names of an attribute that, when updated, will trigger the event. Required by the fieldUpdated trigger_type
nameString The name of the trigger
questionnaire_idsList of String The questionnaire ids that trigger the handler. Required by the questionnaireResponded trigger_type
trigger_conjunctionString 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

Read-Only

created_atString The date the event was created
updated_atString The date the event was updated

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"
}
}