04b2901e1f
We are expanding Chatwoot’s automation capabilities by introducing **Conversation Workflows**, a dedicated section in settings where teams can configure rules that govern how conversations are closed and what information agents must fill before resolving. This feature helps teams enforce data consistency, collect structured resolution information, and ensure downstream reporting is accurate. Instead of having auto‑resolution buried inside Account Settings, we introduced a new sidebar item: - Auto‑resolve conversations (existing behaviour) - Required attributes on resolution (new) This groups all conversation‑closing logic into a single place. #### Required Attributes on Resolve Admins can now pick which custom conversation attributes must be filled before an agent can resolve a conversation. **How it works** - Admin selects one or more attributes from the list of existing conversation level custom attributes. - These selected attributes become mandatory during resolution. - List all the attributes configured via Required Attributes (Text, Number, Link, Date, List, Checkbox) - When an agent clicks Resolve Conversation: If attributes already have values → the conversation resolves normally. If attributes are missing → a modal appears prompting the agent to fill them. <img width="1554" height="1282" alt="CleanShot 2025-12-10 at 11 42 23@2x" src="https://github.com/user-attachments/assets/4cd5d6e1-abe8-4999-accd-d4a08913b373" /> #### Custom Attributes Integration On the Custom Attributes page, we will surfaced indicators showing how each attribute is being used. Each attribute will show badges such as: - Resolution → used in the required‑on‑resolve workflow - Pre‑chat form → already existing <img width="2390" height="1822" alt="CleanShot 2025-12-10 at 11 43 42@2x" src="https://github.com/user-attachments/assets/b92a6eb7-7f6c-40e6-bf23-6a5310f2d9c5" /> #### Admin Flow - Navigate to Settings → Conversation Workflows. - Under Required attributes on resolve, click Add Required Attribute. - Pick from the dropdown list of conversation attributes. - Save changes. Agents will now be prompted automatically whenever they resolve. <img width="2434" height="872" alt="CleanShot 2025-12-10 at 11 44 42@2x" src="https://github.com/user-attachments/assets/632fc0e5-767c-4a1c-8cf4-ffe3d058d319" /> #### NOTES - The Required Attributes on Resolve modal should only appear when values are missing. - Required attributes must block the resolution action until satisfied. - Bulk‑resolve actions should follow the same rules — any conversation missing attributes cannot be bulk‑resolved, rest will be resolved, show a notification that the resolution cannot be done. - API resolution does not respect the attributes. --------- Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: iamsivin <iamsivin@gmail.com> Co-authored-by: Pranav <pranav@chatwoot.com>
68 lines
2.6 KiB
Ruby
68 lines
2.6 KiB
Ruby
# == Schema Information
|
|
#
|
|
# Table name: custom_attribute_definitions
|
|
#
|
|
# id :bigint not null, primary key
|
|
# attribute_description :text
|
|
# attribute_display_name :string
|
|
# attribute_display_type :integer default("text")
|
|
# attribute_key :string
|
|
# attribute_model :integer default("conversation_attribute")
|
|
# attribute_values :jsonb
|
|
# default_value :integer
|
|
# regex_cue :string
|
|
# regex_pattern :string
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
# account_id :bigint
|
|
#
|
|
# Indexes
|
|
#
|
|
# attribute_key_model_index (attribute_key,attribute_model,account_id) UNIQUE
|
|
# index_custom_attribute_definitions_on_account_id (account_id)
|
|
#
|
|
class CustomAttributeDefinition < ApplicationRecord
|
|
STANDARD_ATTRIBUTES = {
|
|
:conversation => %w[status priority assignee_id inbox_id team_id display_id campaign_id labels browser_language country_code referer created_at
|
|
last_activity_at],
|
|
:contact => %w[name email phone_number identifier country_code city created_at last_activity_at referer blocked]
|
|
}.freeze
|
|
|
|
scope :with_attribute_model, ->(attribute_model) { attribute_model.presence && where(attribute_model: attribute_model) }
|
|
validates :attribute_display_name, presence: true
|
|
|
|
validates :attribute_key,
|
|
presence: true,
|
|
uniqueness: { scope: [:account_id, :attribute_model] }
|
|
|
|
validates :attribute_display_type, presence: true
|
|
validates :attribute_model, presence: true
|
|
validate :attribute_must_not_conflict, on: :create
|
|
|
|
enum attribute_model: { conversation_attribute: 0, contact_attribute: 1 }
|
|
enum attribute_display_type: { text: 0, number: 1, currency: 2, percent: 3, link: 4, date: 5, list: 6, checkbox: 7 }
|
|
|
|
belongs_to :account
|
|
after_update :update_widget_pre_chat_custom_fields
|
|
after_destroy :sync_widget_pre_chat_custom_fields
|
|
|
|
private
|
|
|
|
def sync_widget_pre_chat_custom_fields
|
|
::Inboxes::SyncWidgetPreChatCustomFieldsJob.perform_later(account, attribute_key)
|
|
end
|
|
|
|
def update_widget_pre_chat_custom_fields
|
|
::Inboxes::UpdateWidgetPreChatCustomFieldsJob.perform_later(account, self)
|
|
end
|
|
|
|
def attribute_must_not_conflict
|
|
model_keys = attribute_model.to_sym == :conversation_attribute ? :conversation : :contact
|
|
return unless attribute_key.in?(STANDARD_ATTRIBUTES[model_keys])
|
|
|
|
errors.add(:attribute_key, I18n.t('errors.custom_attribute_definition.key_conflict'))
|
|
end
|
|
end
|
|
|
|
CustomAttributeDefinition.include_mod_with('Concerns::CustomAttributeDefinition')
|