Configly Support

v0.8.0 -- Health Check PDF Reports Released: March 2026 This release introduces the Health Check engine with automated configuration analysis, scored reports, AI-powered summaries, and downloadable...

Important Apply endpoints push real changes to your live Zendesk instance. Always preview first and review the impact analysis before confirming. Overview The apply endpoints let you push v...

Overview The GitHub endpoints let you manage the GitHub Sync integration via the API. GitHub must be connected through the Configly UI first, as the API cannot initiate the OAuth authorisation flo...

Overview Drift occurs when changes are made directly in Zendesk that the GitHub repository does not yet reflect. Configly detects these changes automatically and records them as pending drift. You...

Overview The rollback endpoint generates virtual changes that represent the state of your Zendesk configuration before a previous apply operation ran. This lets you reverse changes by restoring th...

Note Webhook subscriptions are scoped to a connection. Your API key can only manage subscriptions for the connection it is scoped to. Overview Outbound webhooks let you receive real-time notific...

Overview When an event occurs on your connection, Configly sends a POST request to every active webhook subscription that includes that event type. Each delivery contains a standard event envelope ...

Overview The Configly API enforces per-key rate limits using a sliding window. Every API key has an hourly request budget based on your subscription tier. The API also applies IP-level brute-force ...

Note All error responses follow the same envelope shape. Your code should read the code field to branch on specific error types rather than parsing the human-readable message. Error envelope Eve...

Overview Retrieve the full list of health checks that the engine can run against a connection's configuration. This is useful for understanding what each check does before running a health check, ...