Gatemi Store Events Developer Reference

The free edition's hooks use the prefix gmsef_, the full edition's gmse_.

Filters

gmsef_announce — free edition

Whether a new order is announced at all. Applied after the message is built and before the order is claimed.

Argument Type
$announce bool true
$order_id int The order

gmse_announce — Full edition

The same, for every event.

Argument Type
$announce bool true
$event string Event key, e.g. order_placed, low_stock
$args array The WooCommerce hook's own arguments
// Do not announce orders under 10.00.
add_filter( 'gmse_announce', function ( $announce, $event, $args ) {
	if ( 'order_placed' !== $event ) {
		return $announce;
	}
	$order = wc_get_order( $args[0] ?? 0 );
	return $announce && $order && (float) $order->get_total() >= 10;
}, 10, 3 );

Returning false before the claim means the order is not marked as announced, so a later event for it can still be posted.

gmse_events — Full edition

The event catalogue. Each entry, keyed by event key, has label, hook (the action to listen to), args (how many arguments that action passes) and subject (order, product, customer or review). An event with the order subject is claimed on the order.

gmse_event_message — Full edition

The message for an event the plugin does not itself declare. Without it, an added event produces an empty message and is never posted.

Argument Type
$message string ''
$event string Event key
$args array The hook's arguments
// Announce WooCommerce coupon creation.
add_filter( 'gmse_events', function ( $events ) {
	$events['coupon_created'] = array(
		'label'   => 'A new coupon',
		'hook'    => 'woocommerce_new_coupon',
		'args'    => 1,
		'subject' => 'coupon',
	);
	return $events;
} );
add_filter( 'gmse_event_message', function ( $message, $event, $args ) {
	if ( 'coupon_created' !== $event ) {
		return $message;
	}
	$coupon = new WC_Coupon( (int) ( $args[0] ?? 0 ) );
	return 'New coupon: ' . $coupon->get_code();
}, 10, 3 );

The new event then appears as a checkbox on each channel.

Full edition: settings, licensing, boot

  • gmse_settings — the merged settings array (enabled, prefix, link, names).
  • gmse_modules — the modules booted.
  • gmse_license_api_url, gmse_update_cache_ttl, gmse_update_retry_ttl, gmse_sync_cache_ttl — licence server and cache lifetimes.

Actions — Full edition

  • gmse_booted — after every module has booted; receives the container.

Storage

Where Key Holds Edition
Option gmse_settings enabled, prefix, link, names Both
Option gmse_channels List of channels: id, name, kind, destination, typed, chat_id, events, enabled Both
Option gmsef_outbox The free edition's queue Free
Option gmse_outbox The full edition's queue Full
Order meta _gmse_posted List of claimed event keys (order_placed, order_status:completed, …) Both
Option gmse_license Licence state Full

A queue entry is keyed event|subject|channel id and holds kind, destination, chat_id, message and tries.

Cron hooks

Hook Edition When
gmsef_flush / gmse_flush Free / Full Single event, scheduled for "now" whenever something is queued
gmsef_sweep / gmse_sweep Free / Full Every five minutes while the queue is not empty
gmse_license_check Full Twice daily, only while a key is entered

The plugin adds a cron schedule for the sweep: gmsef_five_minutes (free) or gmse_five_minutes (full).

To send whatever is waiting from your own code:

do_action( 'gmse_flush' );   // full edition
do_action( 'gmsef_flush' );  // free edition

HTTP

Requests are POST with a JSON body and a 10-second timeout: {"text": …} for Slack, {"chat_id": …, "text": …, "disable_web_page_preview": true} for Telegram's sendMessage. Any 2xx answer counts as delivered.

There are no tables, no REST routes and no storefront output.

Shopping Cart
Scroll to Top