Connect GitHub
This guide shows how to connect a GitHub repository or organization webhook to a Sigvane inbox.
Use it when you are setting up a real repository or organization webhook for an agent, worker, or automation workflow.
Before you begin
Section titled “Before you begin”You’ll need:
- a Sigvane inbox
- the inbox’s webhook URL and signing secret
- admin access to the GitHub repository or organization you want to connect
If you have not created an inbox yet, start with the quick start.
Choose the webhook scope
Section titled “Choose the webhook scope”A good default is one inbox per GitHub repository. That keeps each repository’s signing secret separate and gives your automation a focused stream of events.
Use an organization-level webhook when you want one inbox to receive events for many repositories in the same GitHub organization.
For most first setups, choose a repository webhook.
Copy the Sigvane values
Section titled “Copy the Sigvane values”Open the inbox in Sigvane and copy:
- Webhook url: paste this into GitHub’s Payload URL field.
- Webhook secret: reveal and copy this into GitHub’s Secret field.
Use the exact webhook URL shown by Sigvane. Treat the signing secret like a password.
Add a repository webhook
Section titled “Add a repository webhook”In GitHub, open the repository you want to connect:
- Go to Settings → Webhooks.
- Click Add webhook.
- Fill in the form:
- Payload URL: paste the Sigvane webhook URL.
- Content type: choose
application/json. - Secret: paste the Sigvane signing secret.
- SSL verification: leave Enable SSL verification selected.
- Which events would you like to trigger this webhook?: choose the events your workflow needs.
- Active: leave it checked.
- Click Add webhook.
For a first test, Just the push event is a simple starting point. You can add more events later.
Optional: Add an organization webhook
Section titled “Optional: Add an organization webhook”Use this path when one inbox should receive events for an entire GitHub organization.
In GitHub, open the organization:
- Go to Settings → Webhooks.
- Click Add webhook.
- Use the same settings as a repository webhook:
- Payload URL: paste the Sigvane webhook URL.
- Content type: choose
application/json. - Secret: paste the Sigvane signing secret.
- SSL verification: leave Enable SSL verification selected.
- Which events would you like to trigger this webhook?: choose only the events your workflow needs.
- Active: leave it checked.
- Click Add webhook.
Organization webhooks can send events from many repositories into one inbox. Make sure your workflow can decide which repository each delivery belongs to.
Verify the first delivery
Section titled “Verify the first delivery”When you save a webhook, GitHub sends a ping delivery.
To check it in Sigvane:
- Open the inbox.
- Click View recent items.
- Look for an item with event name
ping.
To check it in GitHub, open the webhook and review Recent Deliveries. GitHub shows the delivery status, request, and response.
Redeliver an event
Section titled “Redeliver an event”If you want to test again without changing repository code, use GitHub’s redelivery option:
- Open the webhook in GitHub.
- Open Recent Deliveries.
- Select a delivery.
- Click Redeliver.
After redelivery, refresh Recent items in Sigvane.
Common mistakes
Section titled “Common mistakes”- Wrong content type. Use
application/json. - Old signing secret. If you changed the secret in Sigvane, update the GitHub webhook too.
- Wrong event selection. If your workflow waits for pull request events, make sure the webhook sends pull request events.
- Wrong webhook scope. Repository webhooks send events for one repository. Organization webhooks can send events for many repositories.
- Delivery failed in GitHub. Open Recent Deliveries on the webhook page and check the response.
What’s next
Section titled “What’s next”Once deliveries are landing in Sigvane, use the CLI when your agent, worker, or workflow is ready to process inbox items.
See How Sigvane works if you want a quick review of the terms used in this guide.
References
Section titled “References”- GitHub Docs: Creating webhooks
- GitHub Docs: Viewing webhook deliveries
- GitHub Docs: Redelivering webhooks