TAN-5687 Webhooks

back/Gemfile

@@ -239,6 +239,7 @@ commercial_engines = [
   'report_builder',
   'smart_groups',
   'user_custom_fields',
+  'webhooks',
 
   # ID verification & SSO engines.
   'id_auth0',

back/Gemfile.lock

@@ -295,6 +295,13 @@ PATH
       rails (~> 7.2)
       ros-apartment (>= 2.9.0)
 
+PATH
+  remote: engines/commercial/webhooks
+  specs:
+    webhooks (1.0.0)
+      http
+      rails (~> 7.0)
+
 PATH
   remote: engines/free/document_annotation
   specs:
@@ -1508,6 +1515,7 @@ DEPENDENCIES
   user_custom_fields!
   vcr (~> 6.2)
   volunteering!
+  webhooks!
   webmock (~> 3.23)
 
 RUBY VERSION

back/app/jobs/log_activity_job.rb

@@ -41,6 +41,7 @@ def run(item, action, user, acted_at = nil, options = {})
     activity = create_activity(item, action, user, acted_at, options)
     trigger_notifications(activity)
     trigger_campaigns(activity)
+    trigger_webhooks(activity)
     publish_activity_to_rabbit(activity)
     trigger_track_activity_job(activity, item)
   end
@@ -78,6 +79,14 @@ def trigger_campaigns(activity)
     EmailCampaigns::TriggerOnActivityJob.perform_later(activity)
   end
 
+  def trigger_webhooks(activity)
+    # Optimization: Skip if no webhooks are enabled. This avoids overhead for
+    # the common case where no webhooks are configured
+    return unless Webhooks::Subscription.any_enabled?
+
+    Webhooks::EnqueueService.new.call(activity)
+  end
+
   def publish_activity_to_rabbit(activity)
     PublishActivityToRabbitJob.perform_later(activity)
   end

back/app/models/custom_field_bin.rb

@@ -22,6 +22,7 @@
 #
 #  fk_rails_...  (custom_field_id => custom_fields.id)
 #  fk_rails_...  (custom_field_option_id => custom_field_options.id)
+#
 
 # A CustomFieldBin defines a subdivision, often relevant for
 # statistical/graphing purposes, over the answer-values of a CustomField. This

back/app/models/project.rb

@@ -333,3 +333,4 @@ def old_folder_moderators
 Project.include(Analysis::Patches::Project)
 Project.include(EmailCampaigns::Extensions::Project)
 Project.include(BulkImportIdeas::Patches::Project)
+Project.include(Webhooks::Patches::Project)

back/config/routes.rb

@@ -8,6 +8,7 @@
   mount Seo::Engine => '', as: 'seo'
   mount Surveys::Engine => '', as: 'surveys'
   mount Volunteering::Engine => '', as: 'volunteering'
+  mount Webhooks::Engine => '', as: 'webhooks'
 
   namespace :web_api, defaults: { format: :json } do
     namespace :v1 do

back/config/schemas/settings.schema.json.erb

@@ -1121,8 +1121,8 @@
 
       "public_api_tokens": {
         "type": "object",
-        "title": "Public API tokens",
-        "description": "Enables the ability to create API tokens for the public API.",
+        "title": "Public API & Webhooks",
+        "description": "Enables the ability to create API tokens for the public API and webhooks. This allows external systems to interact with the platform programmatically.",
         "additionalProperties": false,
         "required": ["allowed", "enabled"],
         "properties": {

back/db/migrate/20251022100723_create_webhooks_subscriptions.webhooks.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This migration comes from webhooks (originally 20251022000001)
+class CreateWebhooksSubscriptions < ActiveRecord::Migration[7.1]
+  def change
+    create_table :webhooks_subscriptions, id: :uuid do |t|
+      t.string :name, null: false
+      t.string :url, null: false
+      t.string :secret_token, null: false
+      t.jsonb :events, default: [], null: false
+      t.uuid :project_id
+      t.boolean :enabled, default: true, null: false
+      t.timestamps
+
+      t.index :enabled
+      t.index :project_id
+      t.index :events, using: :gin
+    end
+
+    add_foreign_key :webhooks_subscriptions, :projects, on_delete: :cascade, validate: false
+  end
+end

back/db/migrate/20251022100724_create_webhooks_deliveries.webhooks.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This migration comes from webhooks (originally 20251022000002)
+class CreateWebhooksDeliveries < ActiveRecord::Migration[7.1]
+  def change
+    create_table :webhooks_deliveries, id: :uuid do |t|
+      t.uuid :webhooks_subscription_id, null: false
+      t.uuid :activity_id, null: false
+      t.string :event_type, null: false
+      t.string :status, null: false, default: 'pending'
+      t.integer :attempts, default: 0, null: false
+      t.integer :response_code
+      t.text :response_body
+      t.text :error_message
+      t.datetime :last_attempt_at
+      t.datetime :succeeded_at
+      t.timestamps
+
+      t.index :webhooks_subscription_id
+      t.index :activity_id
+      t.index %i[webhooks_subscription_id status]
+      t.index :created_at
+      t.index %i[status created_at]
+    end
+
+    add_foreign_key :webhooks_deliveries, :webhooks_subscriptions, on_delete: :cascade, validate: false
+    add_foreign_key :webhooks_deliveries, :activities, on_delete: :cascade, validate: false
+  end
+end

back/db/migrate/20251022100725_validate_webhooks_foreign_keys.webhooks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This migration comes from webhooks (originally 20251022000003)
+class ValidateWebhooksForeignKeys < ActiveRecord::Migration[7.1]
+  def change
+    validate_foreign_key :webhooks_subscriptions, :projects
+    validate_foreign_key :webhooks_deliveries, :webhooks_subscriptions
+    validate_foreign_key :webhooks_deliveries, :activities
+  end
+end