Entwickler

API- & Webhook-Dokumentation.

Eine REST-API und signierte Webhooks, um gescreente, bewertete Kandidaten in Ihr eigenes ATS zu übertragen. Jede Anfrage unten ist live — bearbeiten Sie die Parameter und senden Sie sie an ein funktionierendes Sandbox-Konto, keine Registrierung erforderlich.

Sofort ausprobieren

Jede Konsole auf dieser Seite ist bereits mit einem Lese-/Schreib-Sandbox-API-Key vorausgefüllt (sk_live_d0c50000), der einer Demo-Agentur mit echten Beispieldaten zugeordnet ist. Tauschen Sie ihn gegen Ihren eigenen Key aus API & Webhooks in Ihren ChatSieve-Kontoeinstellungen, sobald Sie bereit sind, gegen Ihren eigenen Mandanten zu testen. Der Sandbox-Key ist öffentlich und wird geteilt — verlassen Sie sich nicht darauf, dass seine Daten bestehen bleiben.

Authentifizierung

Bearer-Token

Jede Anfrage authentifiziert sich mit einem API-Key, der über API & Webhooks in Ihren Kontoeinstellungen erzeugt wird. Keys werden bei der Erstellung einmalig angezeigt — bewahren Sie sie sicher auf.

curl https://api.chatsieve.example.com/api/v1/candidates \
  -H "Authorization: Bearer sk_live_..."

Alle Endpunkte sind auf die Agentur beschränkt, der der Key gehört — es gibt keine Möglichkeit, mit einem gültigen Key Daten eines anderen Mandanten zu lesen oder zu schreiben. Anfragen ohne gültigen Authorization-Header liefern 401 zurück.

Endpunkt

Kandidaten auflisten

GET /api/v1/candidates — nach Status oder Stelle filtern, neueste zuerst.

GET/api/v1/candidates
API-Schlüssel
status
vacancy_id
limit
Endpunkt

Einen Kandidaten abrufen

GET /api/v1/candidates/:id — vollständige Details inklusive WhatsApp-Nachrichtenverlauf, Dokumente und Bewertungsfaktoren. Fügen Sie eine ID aus der obigen Liste ein.

GET/api/v1/candidates/:id
API-Schlüssel
id
Endpunkt

Status eines Kandidaten aktualisieren

POST /api/v1/candidates/:id/status — Annahme oder Ablehnung löst das entsprechende Webhook-Event an jeden abonnierten Endpunkt aus.

POST/api/v1/candidates/:id/status

status must be one of: NEW, SCREENING, PENDING_REVIEW, ACCEPTED, REJECTED

API-Schlüssel
id
Anfragetext (JSON)
Endpunkt

Stellen auflisten

GET /api/v1/vacancies — jede offene Rolle für die authentifizierte Agentur, mit Kandidatenanzahl.

GET/api/v1/vacancies
API-Schlüssel
limit
Endpunkt

Eine Stelle erstellen

POST /api/v1/vacancies — die Mindestfelder, um Bewerber in einen Screening-Ablauf zu leiten.

POST/api/v1/vacancies
API-Schlüssel
Anfragetext (JSON)
Endpunkt

Massen-Screening auslösen

POST /api/v1/bulk-screening — sendet die einleitende WhatsApp-Screening-Nachricht an jeden neuen Kandidaten einer Stelle (oder eine bestimmte candidate_ids-Liste). Nachrichten werden erst real versendet, sobald WhatsApp-Zugangsdaten konfiguriert sind; bis dahin werden sie mit simuliertem Status erfasst.

POST/api/v1/bulk-screening
API-Schlüssel
Anfragetext (JSON)
Referenz

Fehler

Status
Bedeutung
400
Der Anfragetext oder die Query-Parameter fehlen oder sind ungültig — Details siehe Fehlermeldung.
401
Fehlender, fehlerhafter oder widerrufener API-Key.
404
Die Ressource existiert nicht oder gehört nicht zu Ihrer Agentur.
200 / 201
Erfolg — 201 bei Ressourcenerstellung, sonst 200.
Webhooks

Events abonnieren

Registrieren Sie einen Endpunkt über API & Webhooks in Ihren Kontoeinstellungen und wählen Sie, welche Events Sie empfangen möchten. Jeder Endpunkt erhält ein eigenes Signing Secret, das bei der Erstellung einmalig angezeigt wird.

Event
Wird ausgelöst, wenn
candidate.accepted
Der Status eines Kandidaten wird auf ACCEPTED gesetzt (über das Portal oder die API).
candidate.rejected
Der Status eines Kandidaten wird auf REJECTED gesetzt (über das Portal oder die API).
document.flagged
Ein eingereichtes Dokument wird während der Dokumentenprüfung als NEEDS_REVIEW markiert.
Payload-Struktur
{
  "event": "candidate.accepted",
  "created_at": "2026-07-11T10:00:00.000Z",
  "data": {
    "candidate_id": "clx_9f2a7b",
    "name": "Emily Carter",
    "vacancy_id": "vac_platform_eng",
    "score": 92
  }
}
Signatur verifizieren

Jede Zustellung enthält einen X-ChatSieve-Signature-Header — einen HMAC-SHA256-Hex-Digest des rohen Anfragetexts, signiert mit dem Signing Secret Ihres Endpunkts. Verifizieren Sie immer gegen die rohen Bytes, vor jeder JSON-Verarbeitung, und verwenden Sie einen zeitkonstanten Vergleich.

const crypto = require("crypto");

function isValidSignature(rawBody, signatureHeader, signingSecret) {
  const expected = crypto
    .createHmac("sha256", signingSecret)
    .update(rawBody)
    .digest("hex");

  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signatureHeader)
  );
}

// In your webhook route handler:
app.post("/hooks/chatsieve", express.raw({ type: "*/*" }), (req, res) => {
  const signature = req.header("X-ChatSieve-Signature");
  if (!isValidSignature(req.body, signature, process.env.CHATSIEVE_WEBHOOK_SECRET)) {
    return res.status(401).send("Invalid signature");
  }
  const event = JSON.parse(req.body);
  // handle event.event, event.data …
  res.status(200).send("ok");
});
Test-Webhook senden

Sendet eine signierte Beispiel-Payload an eine beliebige von Ihnen angegebene URL, damit Sie Ihren Empfänger testen können, ohne auf ein echtes Kandidaten- oder Dokumentereignis zu warten. Holen Sie sich eine kostenlose Wegwerf-URL bei webhook.site um sie ankommen zu sehen.

API-Schlüssel
Ziel-URL
Ereignis
Referenz

Versionierung

Die aktuelle API-Version ist v1, unter /api/v1/*. Breaking Changes erscheinen unter einem neuen Versionspräfix, statt bestehendes Verhalten zu ändern. Fragen? Sprechen Sie mit uns.

Bereit, ChatSieve mit Ihrem ATS zu verbinden?

Generieren Sie in unter einer Minute einen Live-API-Key über Ihr Konto.

ChatSieve

KI-gestütztes Kandidaten-Screening über WhatsApp, entwickelt für Personalvermittlungen.

Produkt
Unternehmen
Ressourcen
Rechtliches
© 2026 ChatSieve, Inc. Alle Rechte vorbehalten.
Entwickelt für Personalvermittlungen überall.