GitHub Contribution Staking Webhooks

What Webhooks Allow You To Do

Trigger actions when users stake, verify, or claim milestones

Contribution Events

Receive notifications when verification status, staking activities, or contribution milestones change.

NFT Claims

Trigger notifications when new contribution-based NFTs are generated and claimed by users.

Staking Updates

Automatically track staking lockups, rewards distribution, and withdrawal events.

Webhook Setup Guide

Connect your service to GitHub Contribution Staking for real-time updates. Follow these steps to register and handle events.

1

Create a Webhook End-point

Build a server or service that accepts HTTPS POST requests from our API at your endpoint.

2

Get API Token

Login and navigate to Developer Settings to create a new webhook API key.

3

Register Webhook

Register your endpoint and select which event types to receive.

4

Verify Webhook

Test your endpoint with our webhook simulator to ensure proper delivery.

Example Webhook Request


POST YOUR_REGISTERED_ENDPOINT_URL
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "event": "contribution.verified",
  "data": {
    "contribution_id": "12345",
    "github_username": "john",
    "repo_name": "my-project",
    "commit_hash": "a1b2c3d4",
    "timestamp": "2025-09-08T12:34:56Z"
  }
}

Available Webhook Events

contribution.verified

Triggered when a new contribution is verified and marked for staking eligibility.

stake.lock

Sent when a user's contributions are locked for staking with a specific duration.

rewards.distributed

Notifies when rewards are generated and transferred to a user's staking wallet.

nft.generated

Triggered for every new contribution-based NFT created and added to a user's library.

user.connected

Sent when a user links their GitHub account and begins tracking contributions.

stake.withdrawn

Notifies when a user unlocks and withdraws their staked contribution records.

Security Best Practices

Use HTTPS

Ensure all webhooks use HTTPS for secure communication and to prevent tampering with requests in transit.

Validate Signatures

Use API tokens for authentication and ensure all payloads are verified using the provided signature.

Webhooks Integration