Über die Dealsky-API verbindest du Dealsky programmatisch mit deinen eigenen Systemen: Leads, Listen, Kampagnen und Ausschlüsse abrufen oder anlegen – und Webhooks für Echtzeit-Events einrichten. Die API ist in den Paketen Growth und Scale enthalten. Kein Entwickler im Team? Für die meisten Automatisierungen reicht Zapier ganz ohne Code (siehe „Dealsky mit Zapier verbinden").
Basis-URL
https://api.dealsky.io/functions/v1
Authentifizierung
Jede Anfrage authentifizierst du über den Header X-API-Key. Den API-Key erstellst du in Dealsky unter Einstellungen → API & Integrationen → „Neuen API Key erstellen". Du wählst zwischen Live- und Test-Modus; der Key wird nur einmal angezeigt – kopiere ihn sofort und bewahre ihn sicher auf.
Live-Key:
kv_live_…Test-Key:
kv_test_…
Authentifizierung prüfen:
curl -X POST https://api.dealsky.io/functions/v1/auth \
-H "Content-Type: application/json" \
-H "X-API-Key: kv_live_DEIN_KEY" \
-d '{}'
Schnellstart: ersten Lead abrufen
curl -X POST https://api.dealsky.io/functions/v1/actions \
-H "Content-Type: application/json" \
-H "X-API-Key: kv_live_DEIN_KEY" \
-d '{"action": "find_lead", "email": "[email protected]"}'
Endpunkte
Die meisten Aktionen laufen über /actions – Lesen per GET mit Query-Parametern oder per POST mit action im Body, Schreiben per POST.
Leads
find_lead– Lead per E-Mail suchen (Parameter: email)get_lead– Lead per ID abrufen (id)get_lead_journey– Journey eines Leads (id)get_lead_score– Score eines Leads (id)get_lead_emails– E-Mails eines Leads (id)create_lead– Lead anlegen (data: list_id, email, first_name, last_name, company)
Listen
get_list– Liste per ID abrufen (id)get_listid_by_name– Listen-ID per Name finden (name)create_list– neue Liste anlegen
Kampagnen
get_campaign– Kampagne per ID abrufen (id)get_campaignid_by_name– Kampagnen-ID per Name finden (name)
Ausschlüsse
add_exclusion– Kontakt oder Domain zur Ausschlussliste hinzufügen
Webhooks (Echtzeit-Events)
Mit Webhooks bekommst du Ereignisse in Echtzeit an eine eigene URL gepusht.
GET /webhooks– aktive Webhooks auflistenPOST /webhooks– Webhook anlegen (hookUrl, triggerType, optional filterConfig)DELETE /webhooks?id=…– Webhook löschen
Verfügbare Trigger-Events: lead.created, lead.updated, lead.hot, landing_page.visited, video.watched, booking_page.opened, cta.clicked, booking.confirmed, exclusion.added, deletion.requested.
Sicherheit
Sende den Key immer im Header, nicht als URL-Parameter.
Bewahre den Key sicher auf (z. B. als Umgebungsvariable), niemals im Client-Code.
Erneuere den Key regelmäßig (Empfehlung: alle 90 Tage).
Die jeweils aktuellste technische Referenz findest du unter docs.dealsky.io/api.