## Description Adds webhook configuration management for WhatsApp Cloud API channels, allowing administrators to check webhook status and register webhooks directly from Chatwoot without accessing Meta Business Manager. ## Type of change - [ ] New feature (non-breaking change which adds functionality) ## Screenshots <img width="1130" height="676" alt="Screenshot 2026-03-05 at 7 04 18 PM" src="https://github.com/user-attachments/assets/f5dcd9dd-8827-42c5-a52b-1024012703c2" /> <img width="1101" height="651" alt="Screenshot 2026-03-05 at 7 04 29 PM" src="https://github.com/user-attachments/assets/e0bd59f9-2a90-4f24-87c0-b79f21e721ee" /> ## Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
120 lines
4.1 KiB
Ruby
120 lines
4.1 KiB
Ruby
class Whatsapp::WebhookSetupService
|
|
def initialize(channel, waba_id = nil, access_token = nil)
|
|
@channel = channel
|
|
@waba_id = waba_id || channel.provider_config['business_account_id']
|
|
@access_token = access_token || channel.provider_config['api_key']
|
|
@api_client = Whatsapp::FacebookApiClient.new(@access_token)
|
|
end
|
|
|
|
def perform
|
|
validate_parameters!
|
|
|
|
# Register phone number if either condition is met:
|
|
# 1. Phone number is not verified (code_verification_status != 'VERIFIED')
|
|
# 2. Phone number needs registration (pending provisioning state)
|
|
register_phone_number if !phone_number_verified? || phone_number_needs_registration?
|
|
|
|
setup_webhook
|
|
end
|
|
|
|
def register_callback
|
|
validate_parameters!
|
|
setup_webhook
|
|
end
|
|
|
|
private
|
|
|
|
def validate_parameters!
|
|
raise ArgumentError, 'Channel is required' if @channel.blank?
|
|
raise ArgumentError, 'WABA ID is required' if @waba_id.blank?
|
|
raise ArgumentError, 'Access token is required' if @access_token.blank?
|
|
end
|
|
|
|
def register_phone_number
|
|
phone_number_id = @channel.provider_config['phone_number_id']
|
|
pin = fetch_or_create_pin
|
|
|
|
@api_client.register_phone_number(phone_number_id, pin)
|
|
store_pin(pin)
|
|
rescue StandardError => e
|
|
Rails.logger.warn("[WHATSAPP] Phone registration failed but continuing: #{e.message}")
|
|
end
|
|
|
|
def fetch_or_create_pin
|
|
# Check if we have a stored PIN for this phone number
|
|
existing_pin = @channel.provider_config['verification_pin']
|
|
return existing_pin.to_i if existing_pin.present?
|
|
|
|
# Generate a new 6-digit PIN if none exists
|
|
SecureRandom.random_number(900_000) + 100_000
|
|
end
|
|
|
|
def store_pin(pin)
|
|
# Store the PIN in provider_config for future use
|
|
@channel.provider_config['verification_pin'] = pin
|
|
@channel.save!
|
|
end
|
|
|
|
def setup_webhook
|
|
callback_url = build_callback_url
|
|
verify_token = @channel.provider_config['webhook_verify_token']
|
|
|
|
@api_client.subscribe_waba_webhook(@waba_id, callback_url, verify_token)
|
|
|
|
rescue StandardError => e
|
|
Rails.logger.error("[WHATSAPP] Webhook setup failed: #{e.message}")
|
|
raise "Webhook setup failed: #{e.message}"
|
|
end
|
|
|
|
def build_callback_url
|
|
frontend_url = ENV.fetch('FRONTEND_URL', nil)
|
|
phone_number = @channel.phone_number
|
|
|
|
"#{frontend_url}/webhooks/whatsapp/#{phone_number}"
|
|
end
|
|
|
|
def phone_number_verified?
|
|
phone_number_id = @channel.provider_config['phone_number_id']
|
|
|
|
# Check with WhatsApp API if the phone number code verification is complete
|
|
# This checks code_verification_status == 'VERIFIED'
|
|
verified = @api_client.phone_number_verified?(phone_number_id)
|
|
Rails.logger.info("[WHATSAPP] Phone number #{phone_number_id} code verification status: #{verified}")
|
|
|
|
verified
|
|
rescue StandardError => e
|
|
# If verification check fails, assume not verified to be safe
|
|
Rails.logger.error("[WHATSAPP] Phone verification status check failed: #{e.message}")
|
|
false
|
|
end
|
|
|
|
def phone_number_needs_registration?
|
|
# Check if phone is in pending provisioning state based on health data
|
|
# This is a separate check from phone_number_verified? which only checks code verification
|
|
|
|
phone_number_in_pending_state?
|
|
|
|
rescue StandardError => e
|
|
Rails.logger.error("[WHATSAPP] Phone registration check failed: #{e.message}")
|
|
# Conservative approach: don't register if we can't determine the state
|
|
false
|
|
end
|
|
|
|
def phone_number_in_pending_state?
|
|
health_service = Whatsapp::HealthService.new(@channel)
|
|
health_data = health_service.fetch_health_status
|
|
|
|
# Check if phone number is in "not provisioned" state based on health indicators
|
|
# These conditions indicate the number is pending and needs registration:
|
|
# - platform_type: "NOT_APPLICABLE" means not fully set up
|
|
# - throughput.level: "NOT_APPLICABLE" means no messaging capacity assigned
|
|
health_data[:platform_type] == 'NOT_APPLICABLE' ||
|
|
health_data.dig(:throughput, :level) == 'NOT_APPLICABLE'
|
|
|
|
rescue StandardError => e
|
|
Rails.logger.error("[WHATSAPP] Health status check failed: #{e.message}")
|
|
# If health check fails, assume registration is not needed to avoid errors
|
|
false
|
|
end
|
|
end
|