Hooks & Filters Reference

Hooks & Filters Reference

Actions

php// Subscriber lifecycle
do_action( 'om_subscriber_inserted',     int $id, array $data );
do_action( 'om_subscriber_updated',      int $id, array $changes );
do_action( 'om_subscriber_unsubscribed', int $id );
do_action( 'om_subscriber_bounced',      int $id, string $type ); // hard|soft

// Tag events
do_action( 'om_tag_assigned', int $subscriber_id, int $tag_id );
do_action( 'om_tag_removed',  int $subscriber_id, int $tag_id );

// Campaign lifecycle
do_action( 'om_campaign_before_send', int $campaign_id, array $subscriber_ids );
do_action( 'om_campaign_sent',        int $campaign_id );
do_action( 'om_campaign_paused',      int $campaign_id );

// Tracking
do_action( 'om_event_open',       int $subscriber_id, int $campaign_id );
do_action( 'om_event_click',      int $subscriber_id, int $campaign_id, string $url );
do_action( 'om_event_unsubscribe',int $subscriber_id, int $campaign_id );

// Scoring
do_action( 'om_lead_score_updated', int $subscriber_id, int $old, int $new );
do_action( 'om_lifecycle_stage_changed', int $subscriber_id, string $old, string $new );

// Automation
do_action( 'om_automation_run_started',   int $run_id, int $automation_id, int $subscriber_id );
do_action( 'om_automation_run_completed', int $run_id );

// Flow completed (OOnboard integration)
do_action( 'oob_flow_completed', int $flow_id, int $user_id, array $actions );

Filters

php// Modify HTML before sending to each subscriber
apply_filters( 'om_personalise_html', string $html, int $subscriber_id, int $campaign_id );

// Modify merge tags array
apply_filters( 'om_merge_tags', array $tags, int $subscriber_id );

// Override SMTP connection selection
apply_filters( 'om_resolve_smtp_connection', string $conn_id, array $mail_data );

// Filter subscriber data before insert
apply_filters( 'om_before_insert_subscriber', array $data );

// Filter the unsubscribe URL
apply_filters( 'om_unsubscribe_url', string $url, int $subscriber_id );

// Register additional automation trigger types
apply_filters( 'om_automation_trigger_types', array $types );