GitScrum / Docs

Quick Start

Set up your first GitScrum webhook in 5 minutes. Receive real-time task notifications on your server with a simple endpoint.

Set up a webhook endpoint and start receiving real-time events from GitScrum in 5 minutes.

Prerequisites

  • A GitScrum account on a Pro plan or above
  • A project with Manager or Owner permissions
  • A publicly accessible server to receive HTTP POST requests

Step 1: Create a Receiver Endpoint

Set up a simple HTTP endpoint that accepts POST requests. Here is an example using Node.js with Express:

const express = require('express');
const app = express();

app.use(express.json());

app.post('/webhooks/gitscrum', (req, res) => {
  const event = req.body;

  console.log('Received webhook:', JSON.stringify(event, null, 2));

  // Process the event based on type
  // Your business logic here

  res.status(200).json({ received: true });
});

app.listen(3000, () => {
  console.log('Webhook receiver listening on port 3000');
});

Or using Python with Flask:

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/webhooks/gitscrum', methods=['POST'])
def webhook():
    event = request.get_json()

    print(f"Received webhook: {event}")

    # Process the event
    # Your business logic here

    return jsonify({"received": True}), 200

if __name__ == '__main__':
    app.run(port=3000)

Step 2: Configure the Webhook in GitScrum

  1. Open your project in GitScrum
  2. Navigate to Project Settings → Webhooks tab
  3. Expand the Tasks category
  4. In the Task Created (issues.store) row, enter your endpoint URL: https://your-server.com/webhooks/gitscrum
  5. Press Enter or click outside the field to save
  6. The status indicator turns green when saved

Step 3: Test the Webhook

  1. Click the test icon (pulse icon) next to the configured endpoint
  2. GitScrum sends a test payload to your URL
  3. Check your server logs for the incoming request
  4. A success message appears in the UI if your server responds with 2xx

Step 4: Trigger a Real Event

  1. Go to your project's Kanban board
  2. Create a new task
  3. Your webhook endpoint receives an HTTP POST with the full task data

What You Receive

When a task is created, your endpoint receives a JSON payload like this:

{
  "data": {
    "uuid": "abc123-def456",
    "title": "Implement login page",
    "type": {
      "title": "Feature"
    },
    "workflow": {
      "title": "To Do",
      "color": "#6B7280"
    },
    "priority": {
      "title": "Medium",
      "color": "#F59E0B"
    },
    "created_at": {
      "date_for_humans": "2 minutes ago",
      "timezone": "UTC"
    }
  }
}

Next Steps