Quick start

This guide walks you from a brand-new Sigvane account to GitHub delivering events into your inbox. It takes a few minutes.

Before you begin

You’ll need:

• a GitHub account (you’ll sign in with it)
• a GitHub repository where you have admin access — that’s required to add a webhook

1. Sign in

Go to sigvane.com and click Sign in with GitHub. The first time, GitHub asks you to authorize Sigvane.

After authorizing, you land on the Webhook inboxes page. It will be empty for a brand-new account.

2. Create an inbox

Click + New inbox in the top-right corner. In the dialog:

• Slug: pick a short name for the inbox. Use 3–40 lowercase letters, numbers, or hyphens. Start and end with a letter or number.

Click Create inbox. Sigvane creates the inbox and opens it.

One inbox per repository

A good default is one inbox per GitHub repository. That keeps the impact of a rotated or revoked signing secret limited to a single repository, and gives each automation a focused stream of events.

If you want a single stream for an entire organization, point an organization-level GitHub webhook at one inbox instead.

3. Copy the webhook URL and signing secret

On the inbox page you’ll see two values to copy:

1. Under Webhook url, click Copy URL. Keep the URL exactly as Sigvane shows it — don’t shorten it.
2. Under Webhook secret, click Reveal secret, then Copy. This is the inbox’s signing secret; GitHub uses it to sign each delivery so Sigvane can verify the request really came from GitHub.

Treat the signing secret like a password. Anyone who has it can produce signatures that look authentic.

4. Add the webhook in GitHub

Open the GitHub repository you want to connect, in a new tab:

1. Go to Settings → Webhooks.
2. Click Add webhook.
3. Fill in the form:
   • Payload URL: paste the Sigvane webhook URL from step 3.
   • Content type: choose application/json.
   • Secret: paste the Sigvane signing secret from step 3.
   • SSL verification: leave Enable SSL verification selected.
   • Which events would you like to trigger this webhook?: for a first test, Just the push event is a fine starting point. You can broaden this later.
   • Active: leave it checked.
4. Click Add webhook.

5. Verify the first delivery

When you save the webhook, GitHub immediately sends a ping event to confirm the URL works. In Sigvane:

1. Go back to the inbox tab.
2. Click View recent items.
3. You should see a new item, typically with event name ping.

To trigger a real event, push a commit to the repository — or open the webhook on GitHub and use Recent Deliveries → Redeliver — then refresh Recent items in Sigvane.

Troubleshooting

If the inbox stays empty after you save the webhook:

• Wrong URL. Open the GitHub webhook again and confirm the Payload URL matches what Sigvane showed exactly. Pasting only https://api.sigvane.com/ will not work — the inbox ID has to be in the path.
• Wrong content type. It must be application/json, not the default form encoding.
• Stale secret. If you rotated the signing secret in Sigvane after configuring GitHub, paste the latest one into GitHub.
• Delivery failed on GitHub’s side. Open Recent Deliveries on the GitHub webhook page; GitHub shows the response Sigvane returned, which usually points at the cause.

What’s next

Once events are landing in your inbox, you can:

• Browse and inspect deliveries in Sigvane under Recent items.
• Run the Sigvane CLI on your own machine or server to poll the inbox and run a local command per inbox item.