b3d0af84c4
### Description
When integrating the web widget via the JS SDK, customers call
setConversationCustomAttributes and setLabel on chatwoot:ready — before
any conversation exists. These API calls silently fail because the
backend endpoints require an existing conversation. When the visitor
sends their first message, the conversation is created without those
attributes/labels, so the message_created webhook payload is missing the
expected metadata.
This change queues SDK-set conversation custom attributes and labels in
the widget store when no conversation exists yet, and includes them in
the API request when the first message (or attachment) creates the
conversation. The backend now permits and applies these params during
conversation creation — before the message is saved and webhooks fire.
### How to test
1. Configure a web widget without a pre-chat form.
2. Open the widget on a test page and run the following in the browser
console after chatwoot:ready:
`window.$chatwoot.setConversationCustomAttributes({ plan: 'enterprise'
});`
`window.$chatwoot.setLabel('vip');` // must be a label that exists in
the account
3. Send the first message from the widget.
4. Verify in the Chatwoot dashboard that the conversation has plan:
enterprise in custom attributes and the vip label applied.
5. Set up a webhook subscriber for `message_created` confirm the first
payload includes the conversation metadata.
6. Verify that calling `setConversationCustomAttributes` / `setLabel` on
an existing conversation still works as before (direct API path, no
regression).
7. Verify the pre-chat form flow still works as expected.
89 lines
2.6 KiB
Ruby
89 lines
2.6 KiB
Ruby
class Api::V1::Widget::MessagesController < Api::V1::Widget::BaseController
|
|
before_action :set_conversation, only: [:create]
|
|
before_action :set_message, only: [:update]
|
|
|
|
def index
|
|
@messages = conversation.nil? ? [] : message_finder.perform
|
|
end
|
|
|
|
def create
|
|
@message = conversation.messages.new(message_params)
|
|
build_attachment
|
|
@message.save!
|
|
end
|
|
|
|
def update
|
|
if @message.content_type == 'input_email'
|
|
@message.update!(submitted_email: contact_email)
|
|
ContactIdentifyAction.new(
|
|
contact: @contact,
|
|
params: { email: contact_email, name: contact_name },
|
|
retain_original_contact_name: true
|
|
).perform
|
|
else
|
|
@message.update!(message_update_params[:message])
|
|
end
|
|
rescue StandardError => e
|
|
render json: { error: @contact.errors, message: e.message }.to_json, status: :internal_server_error
|
|
end
|
|
|
|
private
|
|
|
|
def build_attachment
|
|
return if params[:message][:attachments].blank?
|
|
|
|
params[:message][:attachments].each do |uploaded_attachment|
|
|
attachment = @message.attachments.new(
|
|
account_id: @message.account_id,
|
|
file: uploaded_attachment
|
|
)
|
|
|
|
attachment.file_type = helpers.file_type(uploaded_attachment&.content_type) if uploaded_attachment.is_a?(ActionDispatch::Http::UploadedFile)
|
|
end
|
|
end
|
|
|
|
def set_conversation
|
|
return unless conversation.nil?
|
|
|
|
@conversation = create_conversation
|
|
apply_labels if permitted_params[:labels].present?
|
|
end
|
|
|
|
def apply_labels
|
|
valid_labels = inbox.account.labels.where(title: permitted_params[:labels]).pluck(:title)
|
|
@conversation.update_labels(valid_labels) if valid_labels.present?
|
|
end
|
|
|
|
def message_finder_params
|
|
{
|
|
filter_internal_messages: true,
|
|
before: permitted_params[:before],
|
|
after: permitted_params[:after]
|
|
}
|
|
end
|
|
|
|
def message_finder
|
|
@message_finder ||= MessageFinder.new(conversation, message_finder_params)
|
|
end
|
|
|
|
def message_update_params
|
|
params.permit(message: [{ submitted_values: [:name, :title, :value, { csat_survey_response: [:feedback_message, :rating] }] }])
|
|
end
|
|
|
|
def permitted_params
|
|
# timestamp parameter is used in create conversation method
|
|
# custom_attributes and labels are applied when a new conversation is created alongside the first message
|
|
params.permit(
|
|
:id, :before, :after, :website_token,
|
|
contact: [:name, :email],
|
|
message: [:content, :referer_url, :timestamp, :echo_id, :reply_to],
|
|
custom_attributes: {},
|
|
labels: []
|
|
)
|
|
end
|
|
|
|
def set_message
|
|
@message = @web_widget.inbox.messages.find(permitted_params[:id])
|
|
end
|
|
end
|