Catchline docs
v1.0.0
Get help
● Catchline · Reference

Every setting, hook and table.
For administrators and developers.

All settings with their defaults, the screens and who may open them, the cron, the Perfex hooks and records the module uses, the database tables, and how to translate or change the module's texts.

Settings stored as catchline_* options35 tables

01Settings

Setup > Settings (administrators). Each value is a Perfex option named catchline_<key>.

Settings, Protection tab: largest submission, submissions per minute, repeat window, signature age, automatic retries, outgoing timeout, CSV row limit and blocked e-mail domains
Settings > Protection
TabSettingDefaultRange or values
ProtectionLargest submission (KB)51216 to 20,480
ProtectionSubmissions per minute, per connection601 to 100,000
ProtectionRepeat window (hours)241 to 8,760
ProtectionSignature age (seconds)30030 to 86,400
ProtectionAutomatic retries30 to 10
ProtectionOutgoing timeout (seconds)103 to 30
ProtectionCSV row limit5,0001 to 100,000
ProtectionBlocked e-mail domainsemptyone per line
Forms and spamPosts per visitor per minute51 to 1,000
Forms and spamPosts per form per minute601 to 100,000
Forms and spamKeep partial answers for (days)300 to 3,650
Forms and spamBuilt forms: a returning visitorFill the existing recordcreate, fill, note, review queue
Forms and spamRefuse throwaway e-mail addresseson
Forms and spamAnswer spam like a successon
Forms and spamAsk for cookie consent firstoff
Forms and spamTurnstile, hCaptcha, reCAPTCHA v2 site and secret keysemptysecrets stored encrypted
RoutingHot score751 to 100
RoutingBehaviour half-life (days)300 (never fade) to 3,650
RoutingFirst reply within (working minutes)151 to 10,080
RoutingRemind after (minutes)100 (no reminder) to 10,080
RoutingWhen the time runs outAlert the owneralert, give to the next person, alert a manager
RoutingManagerEvery administratora staff member
RoutingClaim time (minutes)151 to 1,440
RoutingTeam capacity (open new leads per person)0 (no limit)0 to 1,000
RoutingTelegram bot tokenemptystored encrypted
Follow-upTrack opens and clickson
Follow-upUnsubscribe link text"Unsubscribe"up to 120 characters
Follow-upE-mails per hour, all sequences0 (no limit)0 to 100,000
Follow-upRead replies of the last (days)11 to 30
AttributionCredit the lead toThe last sourcelast, first
AttributionRemember the first visit for (days)901 to 365
AttributionKeep payloads for (days)300 (keep) to 3,650
AttributionSave the sender's IP address in the record noteoff
AISwitch the AI helper onoff
AIProvider, model, API key, endpointAnthropic Claude, prefilled model, empty keysee Optional AI
AIRequests per month / per staff member per day200 / 200 = no limit
AIApply message summaries without askingoff
Reply mailboxesIMAP mailboxes read for repliesnonesee Reply mailboxes
PrivacyExport, erase, remove old payloads nowsee Privacy

The Meta and Google settings are on Setup > Conversions (Conversions), among them Send conversions to Meta only for leads that gave marketing consent (on by default). The Spam and A/B settings of each form are in the form builder.

02Screens and who may open them

MenuScreensPermission
DashboardKey numbers, submissions per day, hot leads, top sources, latest failuresView
FormsForms list and builderView (look and preview), Create, Edit, Delete
Leads and sourcesSubmissions, review queue, lead panel; Sources, CSV importView, plus Create / Edit / Delete for changes
Claim leadsOpen offers and your claimsClaim leads offered to a pool
Follow-upSequencesView, plus Create / Edit / Delete
ReportsOverview, funnel, sources, campaigns, A/B tests, speed to lead, ad costsView; Edit and Delete for ad costs
SetupGetting started, scoring and routing, sales teamView, plus Edit for changes
SetupConversions, outgoing webhooks, settings, system check, sample dataAdministrators
AI queue (when AI is on)Ask the AI, proposals, audit logView; Create / Edit to ask and decide

Details per permission: Staff permissions.

03Cron

The module registers one task with the Perfex cron (register_cron_task, or the after_cron_run hook on Perfex versions without it). The steps and their order: retries, payload clean-up, AI summaries, lead watcher, reply timers, claim expiry, sequences, reply mailboxes, outgoing webhooks, Meta conversions, score decay, unfinished answers clean-up, Lead Ads retries, visit counter clean-up. One failing step does not stop the others; errors go to the log prefixed [catchline]. The time of the last run is the option catchline_cron_last_run.

04Perfex hooks and records

Hooks the module listens to: admin_init (permissions and menu), app_admin_head and app_admin_footer (its CSS and JavaScript on its own pages, and the Catchline button on the Perfex lead page), the filter module_catchline_action_links (links in Setup > Modules), the cron task above, and the filter steward_ai_register_tools (tools for the separate Steward AI module). The bundled MIKODES Perfex Kit prints its own CSS and JavaScript once per page through app_admin_head and app_admin_footer. The module fires no hooks of its own.

Perfex records it writes, always through Perfex's own models so Perfex's hooks and notifications run: leads (leads_model), customers and contacts (clients_model, without the welcome e-mail), tickets (tickets_model), notes (misc_model), tasks (tasks_model), staff notifications (add_notification), custom field values, tags, and lead attachments (Perfex's lead upload folder and files table). E-mails go through Perfex's e-mail library and settings.

Perfex data it reads: leads and their statuses, sources and activity log, customers, contacts, staff, custom fields, tags, countries, currencies and invoices (for revenue and conversion values).

05Database tables

35 tables with your Perfex table prefix, created on activation and removed on uninstall: cl_connections, cl_rules, cl_submissions, cl_review_queue, cl_round_robin, cl_ai_actions, cl_audit, cl_forms, cl_form_versions, cl_variants, cl_placements, cl_partials, cl_files, cl_consents, cl_score_rules, cl_scores, cl_score_events, cl_staff_prefs, cl_claims, cl_speed, cl_lead_watch, cl_route_turns, cl_lead_meta, cl_sequences, cl_sequence_steps, cl_enrollments, cl_email_events, cl_suppressions, cl_reply_mailboxes, cl_outgoing_hooks, cl_hook_deliveries, cl_conversions, cl_campaign_costs, cl_stats_daily, cl_stats_hits. No Perfex table is altered.

06Languages

The module ships English only, in four files under modules/catchline/language/english/: catchline_lang.php, catchline_builder_lang.php, catchline_admin_lang.php and catchline_reports_lang.php. Every key starts with cl_ (or is catchline).

  • Translate: copy the four files into modules/catchline/language/<language>/ (the folder name Perfex uses for that language, for example german) and translate the values. Keep the %s and {1} placeholders. Staff then see the module in their Perfex language.
  • Change a few texts: add the keys you want to change to Perfex's custom_lang.php for that language, as Perfex describes for its own texts. Updates of the module do not overwrite it.
  • Public forms: the buttons and error messages of public forms are the cl_public_* and cl_field_err_* keys. A form with more than one language can also translate them per language on its Languages tab (see Languages of the public form).

Back up your translated files before an update: the module folder is replaced on update.

07Files and folders

PathWhat
modules/catchline/The module (replaced on update)
modules/catchline/config/csrf_exclude_uris.phpThe public posting addresses
uploads/catchline-private/<submission>/Files uploaded through forms
uploads/catchline-private/import/CSV files between preview and import (deleted after a day)