Troubleshooter integration

Quick reference

The full integration walkthrough lives on the Troubleshooter pages: overview and integration code. This doc covers the bits that don't fit there.

What the Troubleshooter does

Replify Troubleshooter is a free, standalone WordPress plugin for plugin authors. It lives on your customers' sites and gives them a one-click way to submit support tickets to your Replify Pro installation, pre-loaded with diagnostic data. No more asking "what version of WordPress are you running?" in every ticket.

The Troubleshooter is free for plugin authors to distribute. It does not require your customers to pay anything. It connects to your Replify Pro site (which does require a Pro licence) via OAuth 2.0.

How it works

1. You (the plugin author) register as a provider on your Replify Pro site.
2. You bundle the Troubleshooter connection into your plugin, or instruct customers to install Replify Troubleshooter separately.
3. The customer authenticates against your Replify site using OAuth 2.0 (register or login flow).
4. Once connected, the customer can submit tickets directly from their WordPress admin. The Troubleshooter attaches environment data automatically.
5. The ticket arrives in your Replify Pro admin with structured diagnostic metadata.

What data gets sent

When a customer submits a ticket through the Troubleshooter, the following environment data is collected and attached:

• WordPress version
• PHP version
• Active plugins (name, version, active/inactive status)
• Active theme (name, version, parent theme if child)
• Hosting environment (server software, MySQL version, memory limit, max execution time)
• Your plugin's specific data (version, settings, any custom diagnostics you register)

This data is sent only when the customer explicitly submits a ticket. There is no background telemetry, no periodic pings, no silent data collection.

Provider registration

To receive Troubleshooter tickets, register your plugin as a provider on your Replify Pro site. In your plugin code, call:

replify_troubleshooter_register_provider()

This function registers your plugin's name, slug, and callback for custom diagnostic data. The registration happens on the customer's site and tells the Troubleshooter which Replify installation to connect to.

Full code examples and parameter reference are at /troubleshooter/integrate/.

Customer control and privacy

The Troubleshooter is designed with customer trust as the priority:

• Explicit opt-in. Customers must actively connect their site. No auto-connection on plugin install.
• Capability gated. Only users with manage_options capability (administrators) can connect or disconnect the Troubleshooter.
• No background telemetry. Data is collected and sent only at the moment a ticket is submitted. Nothing runs on a cron or in the background.
• Disconnect at any time. Customers can revoke the OAuth connection from their WordPress admin. This invalidates all tokens and stops any future submissions.
• Visible data. Before submitting, the customer sees exactly what environment data will be attached. Nothing is hidden.

For the API endpoints that power this flow, see REST API and webhooks.