SpedySpedy Docs

Webhooks

Events von GitHub und Bitbucket empfangen, um Commits und Pull Requests mit Tickets zu verknüpfen.

Webhooks ermöglichen es Spedy, Events von deinem Git-Hosting-Anbieter zu empfangen. Wenn eine Commit-Nachricht oder ein Pull Request eine Ticket-ID referenziert (wie WEB-42), verknüpft Spedy sie automatisch mit dem entsprechenden Ticket.

Unterstützte Anbieter

AnbieterUnterstützte Events
GitHubpush, pull_request, pull_request_review, pull_request_review_comment
Bitbucketrepo:push, pullrequest:created, pullrequest:updated, pullrequest:fulfilled, pullrequest:rejected

GitHub Webhook

POST /api/v1/webhooks/github/{integrationId}

Dieser Endpunkt ist öffentlich (keine Authentifizierung erforderlich). Stattdessen signiert GitHub jeden Payload mit einem geteilten Geheimnis, und Spedy überprüft die Signatur vor der Verarbeitung.

Erforderliche Headers

HeaderBeschreibung
x-github-eventEvent-Typ (z.B. push, pull_request)
x-hub-signature-256HMAC-SHA256-Signatur des Payloads

Beispiel-Response

{
  "processed": true,
  "message": "Push event processed successfully"
}

Bitbucket Webhook

POST /api/v1/webhooks/bitbucket/{integrationId}

Dieser Endpunkt ist öffentlich (keine Authentifizierung erforderlich). Bitbucket signiert jeden Payload mit einem geteilten Geheimnis zur Überprüfung.

Erforderliche Headers

HeaderBeschreibung
x-event-keyEvent-Typ (z.B. repo:push, pullrequest:created)
x-hub-signatureHMAC-Signatur des Payloads

Beispiel-Response

{
  "processed": true,
  "message": "Push event processed successfully"
}

Webhooks einrichten

Webhooks werden über die Spedy-Oberfläche in den Integrationseinstellungen deines Boards konfiguriert. Wenn du ein GitHub- oder Bitbucket-Repository verbindest, stellt Spedy dir die Webhook-URL und das Geheimnis bereit, die du bei deinem Git-Hosting-Anbieter konfigurieren musst.

Wie die Ticket-Verknüpfung funktioniert

Wenn Spedy ein Push- oder Pull-Request-Event empfängt, durchsucht es Commit-Nachrichten und PR-Titel/Beschreibungen nach Ticket-Referenzen im Muster {KÜRZEL}-{NUMMER} (zum Beispiel WEB-42). Übereinstimmende Tickets zeigen automatisch verknüpfte Commits und Pull Requests in ihrer Detailansicht.