Documentation
Can’t find what you’re looking for? See legacy documentation β
Getting Started
Everything you need to know to start marketing with Groundhogg!
- π Email Broadcasts
- π GDPR & CASL Compliance
- π Importing Contacts
- π Cron Jobs
- π Initial Setup Guide
- π Installation Guide
Tutorials
Dive into the deep end of Groundhogg with some advanced topics and tutorials.
- π RTL Support
- π Translating Groundhogg into your language
- π Pruning your email list
- π Lead Distribution
FAQ
Our most frequently asked questions, answered!
Essential Knowledge
Contacts
Everything you need to know about contacts
- π Opt-in Status & Marketability
- π Merging Contacts
- π Export Contacts
- π Search Filters
- π Contacts
- π Custom Fields
- π Importing Contacts
Flows
Learn all about flows!
- π Testing Flows with the Simulator
- π Flow Logic
- π Flow Actions
- π Flow Triggers
- π Using the Flow Editor
- π How Flows Work
Learn how you can send email from Groundhogg
- π What is SMTP?
- π Editor Settings & Defaults
- π UTM Parameters
- π Global Blocks
- π Send Time Optimization
- π Email Broadcasts
- π Transactional Vs Marketing Emails
Administration
What you need to know to manage Groundhogg and your business.
- π Campaigns
- π User Roles & Capabilities
- π GDPR & CASL Compliance
Personalization
Create personalized customer experiences that convert!
- π Conditional Content
- π Replacement Codes
Troubleshooting
Having problems? These articles might help.
Known Issues & Workarounds
Fixes, quirks, and other issues that you might encounter and need help with.
Add-Ons
CRM Add-ons
- π Email Countdown Timer
- π Content Restriction
Sales Add-ons
- π Sales Pipeline
Marketing Add-ons
No docs found.
Other Add-ons
Integrations
Ecommerce
Integrate Groundhogg with your Ecommerce plugin to create unique and special customer experiences.
- π GiveWP
- π Easy Digital Downloads
- π WooCommerce
Forms
Integrate Groundhogg with the form plugin of your choice!
- π Elementor Forms Integration
- π Google reCAPTCHA
- π Cloudflare Turnstile
Learning Management
Integrate Groundhogg with popular LMS plugins
- π Tutor LMS
- π MemberPress
- π LifterLMS
- π LearnDash
Membership
Integrate your membership plugin with Groundhogg to better communicate with your members.
- π MemberPress
SMS Services
Integrate Groundhogg with SMS providers.
No docs found.
SMTP Services
Integrate Groundhogg with your SMTP service of choice.
- π Elastic Email
- π Postmark
- π SendGrid
Developer
Developer Guides
Code Samples
- π Adding custom code to Groundhogg
- π Snippets
Rest API
Action Hooks
- π groundhogg/templates/email/head
- π groundhogg/steps/benchmarks/api
- π groundhogg/scripts/after_register_admin_scripts
- π groundhogg/reset
- π groundhogg/preferences/profile_form
- π groundhogg/preferences/manage/preferences_updated
- π groundhogg/preferences/erase_profile
- π groundhogg/preferences/download_profile
- π groundhogg/loaded
- π groundhogg/form/v2/submit
- π groundhogg/email_logger/after_create_log
- π groundhogg/email/send_failed
- π groundhogg/email/after_send
- π groundhogg/deactivated
- π groundhogg/create_contact_from_user
- π groundhogg/contact_created_from_user
- π groundhogg/contact/tags_removed
- π groundhogg/contact/tag_applied
- π groundhogg/contact/record/nav/inside
- π groundhogg/contact/owner_changed
- π groundhogg/contact/merged
- π groundhogg/contact/created
- π groundhogg/contact/agreed_to_terms
- π groundhogg/admin/register_settings/before
- π groundhogg/admin/init
- π groundhogg/admin/funnel/updated
- π groundhogg/admin/contacts/register_info_cards
- π groundhogg/admin/contact/save
- π groundhogg/activating
- π groundhogg/activated
Filter Hooks
- π groundhogg/unsubscribe_url
- π groundhogg/tracking/target_url
- π groundhogg/steps/run/do_step
- π groundhogg/step/enqueue/event
- π groundhogg/step/can_complete
- π groundhogg/should_convert_user_to_contact_when_user_registered
- π groundhogg/sanitize_object_meta
- π groundhogg/roles/caps/contacts
- π groundhogg/post_merge_tags
- π groundhogg/owners
- π groundhogg/owner_roles
- π groundhogg/mappable_fields
- π groundhogg/get_default_from_name
- π groundhogg/get_default_from_email
- π groundhogg/form/v2/success_url
- π groundhogg/form/submission_handler/is_spam
- π groundhogg/form/submission_handler/contact_args
- π groundhogg/email_template/unsubscribe_text
- π groundhogg/email_template/footer_text
- π groundhogg/email/to
- π groundhogg/email/the_content
- π groundhogg/email/subject
- π groundhogg/contact/profile_picture
- π groundhogg/contact/is_marketable
- π groundhogg/contact/is_deliverable
- π groundhogg/confirmation_url
- π groundhogg/admin/tools/tabs
- π groundhogg/admin/settings/tabs
- π groundhogg/admin/contact/record/tabs
Functions
- π validate_tags
- π update_contact_with_map
- π unsubscribe_url
- π track_page_visit
- π track_activity
- π send_email_notification
- π permissions_key_url
- π managed_page_url
- π is_a_contact
- π gh_mail
- π get_event_arg
- π get_db
- π get_current_contact
- π get_contactdata
- π generate_contact_with_map
- π enqueue_event
- π do_replacements_plain_text
- π do_replacements
- π do_api_benchmark
- π create_user_from_contact
- π create_contact_from_user
- π confirmation_url
- π add_filter_use_once
- π add_event_args
- π add_action_use_once
- π after_form_submit_handler
Classes
- π \Groundhogg\Classes\Task
- π \Groundhogg\Tag
- π \Groundhogg\Submission
- π \Groundhogg\Step
- π \Groundhogg\Classes\Note
- π \Groundhogg\Funnel
- π \Groundhogg\Event
- π \Groundhogg\Email
- π \Groundhogg\Contact
- π \Groundhogg\Campaign
- π \Groundhogg\Broadcast
- π abstract \Groundhogg\Base_Object_With_Meta
- π abstract \Groundhogg\Base_Object
