Getting Started
Core onboarding and setup sequence to go live quickly.
Open sectionHelp Center
Start with self-serve guidance first. Use search and category links below, then escalate with org ID and timestamps if you still need support.
Quick start checklist
- Connect your GitHub account
Start onboarding and authorize API Contract Guard to create your secure workspace session.
- Install the API Contract Guard GitHub App
Approve installation for your organization to allow repository discovery and pull request checks.
- Choose a plan and start your trial
Select a monthly or yearly package, complete Stripe checkout, then return to your workspace.
- Map repositories and services
Sync repositories, then create services and point each service at the correct contract source.
Browse by category
Policies
How to configure policy defaults, overrides, and waivers.
Open sectionTroubleshooting
Known errors and recovery steps for common setup issues.
Open sectionBilling
Trial, checkout, and subscription lifecycle guidance.
Open sectionIntegrations
GitHub app, repository sync, and callback behavior.
Open sectionSearch help articles
Find setup guidance, policy behavior, troubleshooting steps, and billing answers.
Getting Started
Core onboarding and setup sequence to go live quickly.
Can we onboard gradually by team or repository?
Yes. Start with a subset of repositories, map core services first, and expand policy coverage as teams adopt PR checks and waiver workflows.
Policies
How to configure policy defaults, overrides, and waivers.
What should our first policy enforce?
Start by blocking removed endpoints and required-field additions at the organization level, then add service-level overrides where migration windows are needed.
When should we use waivers instead of overrides?
Use waivers for temporary exceptions tied to a specific check failure and expiration date. Use overrides when a service needs an intentional long-running policy difference.
Troubleshooting
Known errors and recovery steps for common setup issues.
Create Service returns a fetch or request error.
Confirm your org is trialing/active, check selected repository availability, and ensure API/web share the same public origin. Then inspect API logs for validation details.
Why are pull request checks not running?
Check that the repository is mapped to a service, GitHub app webhook delivery is healthy, and contract path settings resolve correctly in the repository branch being tested.
Billing
Trial, checkout, and subscription lifecycle guidance.
Billing status does not match my Stripe action.
Confirm Stripe webhook delivery and signing secret validity. Subscription state is updated by checkout and webhook events, so webhook failures can leave stale plan status.
How do we move to an enterprise agreement?
Use the Contact Sales path on pricing for enterprise onboarding, procurement, and support/SLA discussions.
Integrations
GitHub app, repository sync, and callback behavior.
GitHub connect or app install callback fails. What should I check first?
Verify your OAuth callback and GitHub App setup URLs both point to the same public domain and auth endpoints. Also confirm state parameters are preserved through all redirects.
My repositories do not appear after installation.
Use the repository refresh action after installation permission changes. Confirm app repository permissions in GitHub and that the installation is linked to the expected organization.
Need escalation?
Contact support@apicontractguard.com for incident and account support.