Gatemi List Sync Developer Reference

Read from the plugin code. The free edition is plain WordPress PHP (GMSYF_* classes); the full edition is namespaced (GatemiListSync).

Filters — Full edition

Filter Arguments What it changes
gmsy_should_sync bool $sync, WC_Order $order Return false to hold one order back. Runs after the consent check and before the claim, so a held-back order can still sync later.
gmsy_contact_tags array $tags, WC_Order $order The tags one contact is given. Non-string values are dropped.
gmsy_batch int $batch (default 25) How many queued contacts one run writes. Clamped to 1–200.
gmsy_providers array $providers The provider catalog: label, host, suffix, auth, list_hint, key_hint per provider id — plus path, method, payload and auth_header for a provider an extension adds.
gmsy_settings array $settings The settings after defaults are merged in.
gmsy_modules array $modules The ordered module list the plugin boots.
gmsy_license_api_url string $url The gatemi.com licensing endpoint.
gmsy_update_cache_ttl int $seconds How long the update payload is cached.

An extra provider added through gmsy_providers appears in the dropdown and gets the host check. To be written to, its entry must also declare where and how (full edition):

  • path — the request path on its own host, with {list}, {email} and {email_md5} filled in, for example /api/lists/{list}/profiles;
  • method — POST (default), PUT or PATCH;
  • payload — a callable ( array $contact, array $tags, string $list_id ): array returning the request body;
  • auth — header (the key in the header named by auth_header, default api-key), bearer, or basic.

A provider without a path has no address and one without a payload is refused with a reason on the screen — neither is ever sent a Mailchimp-shaped request.

The free edition applies no filters.

Example: never sync wholesale orders

add_filter( 'gmsy_should_sync', function ( $sync, $order ) {
	$user = $order->get_user();
	if ( $user && in_array( 'wholesale_customer', (array) $user->roles, true ) ) {
		return false;
	}
	return $sync;
}, 10, 2 );

Example: tag first-time customers

add_filter( 'gmsy_contact_tags', function ( $tags, $order ) {
	$count = wc_get_orders( array(
		'billing_email' => $order->get_billing_email(),
		'status'        => array( 'processing', 'completed' ),
		'return'        => 'ids',
		'limit'         => 2,
	) );
	if ( count( $count ) <= 1 ) {
		$tags[] = 'First order';
	}
	return $tags;
}, 10, 2 );

Actions

gmsy_booted (full edition) fires after every module has booted, with the plugin's container. Neither edition fires any other action of its own.

Cron hooks

Hook Edition Kind
gmsyf_flush / gmsy_flush Free / Full Single event, started when a contact is queued.
gmsyf_sweep / gmsy_sweep Free / Full Every five minutes (schedule gmsyf_five_minutes / gmsy_five_minutes), only while something is waiting.
gmsy_license_check Full The licence check, once a key is entered.

The queue's own hooks are separate per edition, because a queue is short-lived working data rather than a store record.

Options

Option Edition Holds
gmsy_settings Both enabled, provider, api_key, list_id, optin, optin_label; full edition also history, category_tags, tags, status.
gmsyf_outbox Free The free edition's queue (up to 200 rows).
gmsy_outbox Full The full edition's queue (up to 500 rows).
gmsy_license Full Licence state.

A queue row is keyed by lower-cased email and holds contact, tags (full edition), tries, try_after (Unix time) and error. Both queues are stored with autoload off.

Order meta (both editions)

Key Value
_gmsy_optin array( 'yes' => true, 'label' => '…as shown…', 'at' => 'Y-m-d H:i:s' UTC )
_gmsy_synced The UTC time the order was claimed for syncing.
_wc_other/gatemi-list-sync/optin WooCommerce's own storage of the Checkout block field (1 when ticked).

Checkout fields

  • Classic checkout: <input type="checkbox" name="gmsy_optin" value="yes"> inside <p class="form-row gmsy-optin">.
  • Checkout block: additional checkout field id gatemi-list-sync/optin, location order, type checkbox, not required.

Outbound requests

Provider Method and URL Auth
Mailchimp PUT https://{dc}.api.mailchimp.com/3.0/lists/{list}/members/{md5(email)} HTTP Basic, key as password
Brevo POST https://api.brevo.com/v3/contacts api-key header

Timeout 15 seconds. These are the only hosts either edition contacts, apart from gatemi.com for the full edition's licence once a key is entered.

What it does not have

No database tables, no REST routes, no shortcodes, no storefront scripts, and no customer (user) meta.

Shopping Cart
Scroll to Top