feat: Add inbox webhook events (#8006)

- Add webhook events for inbox creation/updation.
- Right now, the feature is added under a feature_flag. It is not available by default on all installations.

app/listeners/base_listener.rb

@@ -24,6 +24,11 @@ class BaseListener
     [contact, contact.account]
   end
 
+  def extract_inbox_and_account(event)
+    inbox = event.data[:inbox]
+    [inbox, inbox.account]
+  end
+
   def extract_changed_attributes(event)
     changed_attributes = event.data[:changed_attributes]
 

app/listeners/webhook_listener.rb

@@ -66,6 +66,23 @@ class WebhookListener < BaseListener
     deliver_account_webhooks(payload, account)
   end
 
+  def inbox_created(event)
+    inbox, account = extract_inbox_and_account(event)
+    inbox_webhook_data = Inbox::EventDataPresenter.new(inbox).push_data
+    payload = inbox_webhook_data.merge(event: __method__.to_s)
+    deliver_account_webhooks(payload, account)
+  end
+
+  def inbox_updated(event)
+    inbox, account = extract_inbox_and_account(event)
+    changed_attributes = extract_changed_attributes(event)
+    return if changed_attributes.blank?
+
+    inbox_webhook_data = Inbox::EventDataPresenter.new(inbox).push_data
+    payload = inbox_webhook_data.merge(event: __method__.to_s, changed_attributes: changed_attributes)
+    deliver_account_webhooks(payload, account)
+  end
+
   private
 
   def deliver_account_webhooks(payload, account)

app/models/inbox.rb

@@ -77,6 +77,9 @@ class Inbox < ApplicationRecord
 
   after_destroy :delete_round_robin_agents
 
+  after_create_commit :dispatch_create_event
+  after_update_commit :dispatch_update_event
+
   scope :order_by_name, -> { order('lower(name) ASC') }
 
   def add_member(user_id)
@@ -159,6 +162,18 @@ class Inbox < ApplicationRecord
 
   private
 
+  def dispatch_create_event
+    return if ENV['ENABLE_INBOX_EVENTS'].blank?
+
+    Rails.configuration.dispatcher.dispatch(INBOX_CREATED, Time.zone.now, inbox: self)
+  end
+
+  def dispatch_update_event
+    return if ENV['ENABLE_INBOX_EVENTS'].blank?
+
+    Rails.configuration.dispatcher.dispatch(INBOX_UPDATED, Time.zone.now, inbox: self, changed_attributes: previous_changes)
+  end
+
   def ensure_valid_max_assignment_limit
     # overridden in enterprise/app/models/enterprise/inbox.rb
   end

app/models/webhook.rb

@@ -26,7 +26,7 @@ class Webhook < ApplicationRecord
   enum webhook_type: { account_type: 0, inbox_type: 1 }
 
   ALLOWED_WEBHOOK_EVENTS = %w[conversation_status_changed conversation_updated conversation_created contact_created contact_updated
-                              message_created message_updated webwidget_triggered].freeze
+                              message_created message_updated webwidget_triggered inbox_created inbox_updated].freeze
 
   private
 

app/presenters/inbox/event_data_presenter.rb

@@ -0,0 +1,35 @@
+class Inbox::EventDataPresenter < SimpleDelegator
+  def push_data
+    {
+      # Conversation thread config
+      allow_messages_after_resolved: allow_messages_after_resolved,
+      lock_to_single_conversation: lock_to_single_conversation,
+
+      # Auto Assignment config
+      auto_assignment_config: auto_assignment_config,
+      enable_auto_assignment: enable_auto_assignment,
+
+      # Feature flag for message events
+      enable_email_collect: enable_email_collect,
+      greeting_enabled: greeting_enabled,
+      greeting_message: greeting_message,
+      csat_survey_enabled: csat_survey_enabled,
+
+      # Outbound email sender config
+      business_name: business_name,
+      sender_name_type: sender_name_type,
+
+      # Business hour config
+      timezone: timezone,
+      out_of_office_message: out_of_office_message,
+      working_hours_enabled: working_hours_enabled,
+      working_hours: working_hours,
+
+      created_at: created_at,
+      updated_at: updated_at,
+
+      # Associated channel attributes
+      channel: channel
+    }
+  end
+end