Webhook & API
Infos zur API-Anbindung und technischen Integration.
1. Überblick
Vergabepilot.AI stellt Webhooks zur Verfügung, um Ausschreibungsdaten automatisiert in externe Systeme zu übertragen. Die klassische REST-API ist nicht öffentlich verfügbar.
Die Nutzung der Webhooks ist auf Anfrage per E-Mail verfügbar und kostet 390 Euro pro Jahr zzgl. MwSt.
Webhooks ermöglichen es, relevante Ereignisse in Echtzeit per HTTP-POST an ein definiertes Zielsystem zu senden. Typische Anwendungsfälle sind:
- Übergabe relevanter Ausschreibungen an CRM-Systeme
- Automatisierte Benachrichtigungen in internen Tools
- Anbindung an Workflow- und Automatisierungsplattformen
- Synchronisation mit internen Datenbanken
Die übertragenen Daten werden im JSON-Format versendet.
2. Webhooks anlegen
Webhooks werden auf Organisationsebene konfiguriert.
Pfad:
Organisation → Management → Integrationen
Dort können beliebig viele Webhook-Integrationen angelegt und verwaltet werden.
Als Zielsystem kann entweder
- ein eigener Webserver oder
- ein externer Automatisierungsdienst wie Zapier, Make oder n8n
verwendet werden.
3. Konfiguration einer Integration
Beim Erstellen oder Bearbeiten einer Integration stehen folgende Optionen zur Verfügung:
Feld | Pflicht | Beschreibung |
URL | Ja | Ziel-URL, an die die Events per HTTP POST gesendet werden |
Header-Name | Nein | Optionaler HTTP-Header, z.B. für Authentifizierung |
Header-Value | Nein | Token, API-Key oder Zugangsdaten für den Header |
Events | Ja | Auswahl der Event-Typen, die gesendet werden sollen |
Aktiviert | Nein | Gibt an, ob der Webhook aktiv ist |
Hinweis:
Die Events werden nur versendet, wenn die Integration aktiviert ist.
4. Event-Struktur
Jedes Webhook-Event besteht aus einem Event-Typ und einem dazugehörigen Payload.
Grundstruktur:
{
"type": "EVENT_TYP",
"payload": {
"...": "event-spezifische Daten"
}
}
Der konkrete Inhalt des Payloads hängt vom jeweiligen Event-Typ ab.
5. Event-Typen
5.1 Suchprofil ausgeführt
Event-Typ:
NEW_SEARCH_AGENT_EXECUTION
Beschreibung:
Dieses Event wird ausgelöst, wenn ein gespeichertes Suchprofil automatisch ausgeführt wurde und mindestens ein passendes Suchergebnis gefunden wurde.
Typische Einsatzszenarien:
- Automatisches Erstellen von Leads im CRM
- Benachrichtigung des Vertriebs bei neuen relevanten Ausschreibungen
- Übergabe an interne Bewertungssysteme
Payload (Beispiel)
{
"searchAgent": {
"id": "415fbca1-2f82-4720-bf4b-b63e7d0635e6",
"name": "Testagent",
"interval": "DAILY"
},
"searchQuery": {
"id": "17de612e-08f5-4345-96b8-5931c9e19049",
"description": "Bauwerksprüfung"
},
"searchExecution": {
"id": "03d74de9-32c7-477f-987e-bd6552cd7624",
"searchedTenders": 11,
"matchingTenders": 1,
"totalResults": 1
},
"searchResults": [
{
"id": "4276d278-fed6-45a3-85eb-ded99938ad97",
"rank": 1,
"score": 75,
"tender": {
"id": "be171fda-9f07-40e8-b67a-39cfc1ba6247",
"name": "Bauwerksprüfung für Brücken und Verkehrszeichenbrücken in Nordbayern",
"code": "JGAXKWSQ6QXG",
"slug": "bauwerkspruefung-fuer-bruecken-und-verkehrszeichenbruecken-in-nordbayern"
}
}
],
"tenderData": {
"be171fda-9f07-40e8-b67a-39cfc1ba6247": {
"tenderUrl": "https://www.vergabepilot.ai/ausschreibungen/JGAXKWSQ6QXG/...",
"sourceUrl": "https://www.vergabepilot.ai/ausschreibungen/JGAXKWSQ6QXG/.../quelle",
"procurement": {
"scope": "EU",
"activity": "DIENSTLEISTUNGEN",
"procedure": "OFFENES_VERFAHREN",
"regulation": "VERGABEVERORDNUNG_VGV",
"summary": "...",
"officialBudget": 100000
},
"contractor": {
"authority": {
"name": "Die Autobahn GmbH des Bundes - NL Nordbayern"
}
},
"timeline": {
"publicationBegin": "2025-01-07T23:00:00Z",
"submissionEnd": "2025-12-31T11:00:00Z"
}
}
}
}
Hinweis:
Viele Felder sind optional und können je nach Ausschreibung fehlen.
6. Integration testen
Zum Testen einer Webhook-Integration kann ein externer Test-Service verwendet werden, z.B. webhook.site.
Vorgehen:
- Test-URL bei webhook.site erstellen
- URL in der Integration hinterlegen
- In Vergabepilot.AI auf „Testereignis“ klicken
- Event-Typ auswählen
- Payload im Zielsystem prüfen
So lassen sich Struktur und Inhalte vor der produktiven Nutzung verifizieren.
7. Fehlerbehandlung
- Liefert das Zielsystem einen Fehler oder ist nicht erreichbar, wird das betroffene Event übersprungen
- Die Webhook-Integration bleibt weiterhin aktiv
- Administratoren der Organisation erhalten eine In-App-Benachrichtigung über den Fehler
Es erfolgt aktuell kein automatisches Retry.
8. Unterstützte Systeme
Webhooks sind bewusst generisch gehalten und können mit nahezu allen Systemen genutzt werden.
Häufige Anbindungen:
- HubSpot
- Pipedrive
- Salesforce
- Interne CRM- oder ERP-Systeme
- Automatisierungsplattformen wie Zapier, Make oder n8n
9. Support
Bei Fragen zur Einrichtung oder bei komplexeren Integrationsszenarien unterstützt euch unser Support-Team gerne.
Insbesondere für individuelle Anbindungen oder spezielle Event-Anforderungen bitten wir um kurze Kontaktaufnahme.