The ObservePoint GitHub integration allows you to trigger Audits directly within your CI/CD pipelines. This supports "Shift-Left" testing, enabling you to catch analytics and tracking errors before code reaches production.
This integration utilizes a secure "Share Link" workflow. This allows ObservePoint users to initiate the setup and simply send a unique URL to their GitHub Administrator for authorization, removing the need to share credentials or manually manage API keys.
Setup Instructions
1. Generate the Configuration URL
Log in to ObservePoint.
Navigate to Settings > GitHub Integrations.
Located under the Unique Configuration URL field, click the Copy Unique URL button.
Note: For security, this unique link expires after 7 days. If the link expires before authorization is complete, you must generate a new one in the ObservePoint interface.
2. Authorize the Integration
Share the copied unique URL with your organization's GitHub Administrator (via email, Slack, etc.).
The Administrator opens the URL in a browser. They will be automatically redirected to sign in with their GitHub account (if they aren't already signed in).
GitHub will prompt them to authorize the ObservePoint GitHub Integration.
Once authorization is complete, the status in ObservePoint will update from Pending to Active within 30 seconds.
3. Alternative Setup
Install ObservePoint App from GitHub marketplace.
This will generate a code
Choose "Enter Code..." option.
Enter code provided by GitHub Administrator to complete authentication in ObservePoint.
Using the Integration
Once the integration is active, you can configure your GitHub workflows to automatically run specific Audits when code is pushed to a repository or a Pull Request is opened.
To implement the workflow, use the ObservePoint Start Audit action available in the GitHub Marketplace:
Troubleshooting
What if the link expires? The configuration link is time-sensitive for security purposes. If your GitHub Administrator sees an expiration message, return to the GitHub Integration page in ObservePoint, generate a new link, and share it again.
How do I remove the integration? If you need to disconnect the integration, navigate to the GitHub Integration setup page in ObservePoint and click the trash can icon labeled Remove this instance from ObservePoint. This will uninstall in ObservePoint and in Github automatically.