Setup Tutorial

Developer API: All WordPress Hooks & Filters

SwiftSync is built with developers in mind. Intercept events, bypass syncing for custom conditions, modify payload data before dispatch, or customize queue limits using native WordPress action and filter hooks.

1. Order & Checkout Synchronization Filters

Bypass or decorate order sync events and checkout payloads:

// 1. Conditionally bypass order syncing (e.g. orders under $10)
add_filter( 'swiftsync_should_sync_order', function( $should_sync, $order_id, $order ) {
    if ( $order && $order->get_total() < 10.00 ) {
        return false;
    }
    return $should_sync;
}, 10, 3 );

// 2. Customize outgoing order payload before dispatching to ClickUp
add_filter( 'swiftsync_order_payload', function( $payload, $order ) {
    $payload['meta_data']['gift_note'] = get_post_meta( $order->get_id(), '_gift_note', true );
    return $payload;
}, 10, 2 );

// 3. Customize draft checkout payload
add_filter( 'swiftsync_checkout_payload', function( $payload, $order_id, $order ) {
    $payload['cart_hash'] = $order->get_cart_hash();
    return $payload;
}, 10, 3 );
                

2. Customer & User Profile Filters

Control customer registration sync rules and payload data:

// 4. Bypass customer sync for test email accounts
add_filter( 'swiftsync_should_sync_customer', function( $should_sync, $customer_id, $new_data ) {
    if ( isset( $new_data['email'] ) && strpos( $new_data['email'], '@test.com' ) !== false ) {
        return false;
    }
    return $should_sync;
}, 10, 3 );

// 5. Decorate outgoing customer profile payload
add_filter( 'swiftsync_customer_payload', function( $payload, $customer_id ) {
    $payload['vip_status'] = 'Active';
    return $payload;
}, 10, 2 );
                

3. Order Notes & Refund Payload Interceptors

Modify notes and refund dispatches sent to ClickUp comment threads:

// 6. Customize refund event payload
add_filter( 'swiftsync_refund_payload', function( $payload, $refund_id, $order ) {
    $payload['refund_reason'] = get_post_meta( $refund_id, '_refund_reason', true );
    return $payload;
}, 10, 3 );

// 7. Customize order note payload
add_filter( 'swiftsync_order_note_payload', function( $payload, $note_id, $order ) {
    $payload['urgency'] = 'High';
    return $payload;
}, 10, 3 );
                

4. Transport, Retry Limits & Request Headers

Customize retry counts, backoff delays, request headers, and event topics:

// 8. Increase maximum fail-safe retry attempts
add_filter( 'swiftsync_retry_limit', function( $limit ) {
    return 5;
} );

// 9. Customize retry backoff delay (in seconds)
add_filter( 'swiftsync_retry_delay', function( $delay, $attempts, $topic ) {
    return 15 * $attempts; // Linear 15s backoff
}, 10, 3 );

// 10. Add custom HTTP request headers
add_filter( 'swiftsync_api_request_headers', function( $headers, $endpoint ) {
    $headers['X-Developer-ID'] = 'dev-team-01';
    return $headers;
}, 10, 2 );

// 11. Modify raw HTTP request parameters
add_filter( 'swiftsync_api_request_args', function( $args, $endpoint ) {
    $args['timeout'] = 30; // 30s connection timeout
    return $args;
}, 10, 2 );

// 12. Override event topic identifier dynamically
add_filter( 'swiftsync_event_topic', function( $topic, $event_type ) {
    return 'custom_' . $topic;
}, 10, 2 );
                

5. Event Action Listeners

Listen for dispatch outcomes or scheduled retries inside your codebase:

// 13. Trigger custom logic on successful payload dispatch
add_action( 'swiftsync_event_dispatched', function( $event_type, $response, $payload ) {
    error_log( "SwiftSync event {$event_type} successfully dispatched to ClickUp." );
}, 10, 3 );

// 14. Trigger alert when a payload dispatch fails
add_action( 'swiftsync_event_failed', function( $event_type, $error_message, $payload ) {
    error_log( "SwiftSync dispatch failed: {$error_message}" );
}, 10, 3 );

// 15. Intercept scheduled retry execution events
add_action( 'swiftsync_retry_event', function( $job_id, $topic, $payload ) {
    error_log( "Retrying SwiftSync job {$job_id} for topic {$topic}" );
}, 10, 3 );