Übersicht

Über die API können erfahrene Nutzer den Kalender an weitere Systeme wie z.B. Make.com (Integromat) anschließen.

Diese Funktion steht in der Premium-Version zur Verfügung

API-Key

API-Keys können Sie in den Admin-Einstellungen unter API erstellen und verwalten. Der API-Key muss bei jeder Anfrage als Header mitgeschickt werden:

X-API-KEY: {{YOUR_API_KEY}}

Termine abrufen

Rufen Sie eine Liste aller Termine innerhalb eines bestimmten Zeitraums ab:

curl --location --request GET 'https://api.kalender.digital/public/event?startDate=2021-01-01&endDate=2025-01-01&timeZone=Europe/Berlin&query=' \
--header 'X-API-KEY: {{YOUR_API_KEY}}'

Einzeltermin abrufen

curl --location --request GET 'https://api.kalender.digital/public/event/{{EVENT_ID}}?timeZone=Europe/Berlin' \
--header 'X-API-KEY: {{YOUR_API_KEY}}'

Termin erstellen

curl --location --request POST 'https://api.kalender.digital/public/event' \
--header 'X-API-KEY: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "startDate": "2025-07-01 12:00:00",
    "endDate": "2025-07-01 13:00:00",
    "timeZone": "Europe/Berlin",
    "title": "API Test",
    "subCalendars": [{{SUBCALENDAR_ID/SUBCALENDAR_NAME}}],
    "description": "",
    "who": "",
    "where": "",
    "wholeDay": false,
    "links": []
}'

Termin ändern

curl --location --request PUT 'https://api.kalender.digital/public/event/{{EVENT_ID}}' \
--header 'X-API-KEY: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "startDate": "2025-07-01 13:00:00",
    "endDate": "2025-07-01 14:00:00",
    "timeZone": "Europe/Berlin",
    "title": "API Test",
    "subCalendars": [{{SUBCALENDAR_ID/SUBCALENDAR_NAME}}],
    "description": "",
    "who": "",
    "where": "",
    "wholeDay": false,
    "links": []
}'

Termin löschen

curl --location --request DELETE 'https://api.kalender.digital/public/event/{{EVENT_ID}}' \
--header 'X-API-KEY: {{YOUR_API_KEY}}'

Unterkalender erstellen

curl --location --request POST 'https://api.kalender.digital/public/subcalendar' \
--header 'X-API-KEY: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "API Test"
}'

Unterkalender ändern

curl --location --request POST 'https://api.kalender.digital/public/subcalendar/{{SUBCALENDAR_ID}}' \
--header 'X-API-KEY: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "API Test"
}'

Unterkalender löschen

curl --location --request DELETE 'https://api.kalender.digital/public/subcalendar/{{SUBCALENDAR_ID}}' \
--header 'X-API-KEY: {{YOUR_API_KEY}}'

Webhooks

Mit Webhooks können Sie automatische Benachrichtigungen und Integrationen mit anderen Systemen einrichten. Folgende Ereignisse können ausgelöst werden:

  • Termin erstellt

  • Termin geändert

  • Termin gelöscht

Webhook einrichten

Gehen Sie in den Einstellungen im Menüpunkt API unter API Keys auf die Schaltfläche Webhooks. Klicken Sie auf + Neuer Webhook und geben Sie die entsprechenden Daten ein.


Webhooks


Platzhalter für Webhooks:

{{EVENT_ID}} ID des Termins

{{REQUEST_TYPE}} CREATE, UPDATE oder DELETE

{{START_DATE}} Startzeit lokal

{{END_DATE}} Endzeit lokal

{{WHOLEDAY}} Ganztagestermin (true/false)

{{TITLE}} Titel

{{DESCRIPTION}} Beschreibung

{{WHO}} Wer

{{WHERE}} Wo

{{LINKS}} Links (Array)

{{SUBCALENDARS}} Unterkalender (String kommagetrennt)

{{TIMEZONE}} Zeitzone