Webhooks

Business+

Konfigurieren Sie Webhook-Endpunkte.

Erforderliche Bereiche: webhooks

Zugriffsstufe: GET webhooks:read POST / PUT / PATCH / DELETE webhooks:write Mehr zu Zugriffsstufen

Feature-Flag: webhooks

Endpunkte

GET


                    /api/v1/webhooks

Alle Webhooks auflisten

GET


                    /api/v1/webhooks/{id}

Einzelnen Webhook abrufen

POST


                    /api/v1/webhooks

Neuen Webhook erstellen

DELETE


                    /api/v1/webhooks/{id}

Webhook löschen

GET


                    /api/v1/webhooks/events

Verfügbare Event-Typen auflisten

Request-Schema

Parameter	Typ	Erforderlich	Beschreibung
`url`	string	Ja	URL des Webhook-Endpunkts (HTTPS erforderlich)
`events`	array	Ja	Array von Event-Typen zum Abonnieren
`name`	string	Nein	Anzeigename für den Webhook
`is_active`	boolean	Nein	Ob der Webhook aktiv ist (Boolean, Standard: true)
`headers`	object	Nein	Benutzerdefinierte HTTP-Header als Objekt aus "Header-Name": "Wert"-Paaren (max. 20; Namen nur A-Z, 0-9 und Bindestrich; keine Zeilenumbrüche in Werten; Host, Content-Type, Content-Length, Transfer-Encoding, Connection, User-Agent und X-Webhook-* können nicht überschrieben werden)
`retry_count`	integer	Nein	Anzahl der Wiederholungsversuche bei Fehler, 0-10 (Standard: 3)
`timeout_seconds`	integer	Nein	Zeitüberschreitung der Anfrage in Sekunden, 5-120 (Standard: 30)

Response-Schema

Feld	Typ
`id`	integer
`name`	string
`url`	string
`events`	array
`is_active`	boolean
`retry_count`	integer
`timeout_seconds`	integer
`last_triggered_at`	string\|null
`last_success_at`	string\|null
`last_failure_at`	string\|null
`failure_count`	integer
`secret`	string (create/show only)
`created_at`	string

Codebeispiele

curl -X GET "https://ihr-mandant.plandocket.com/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://ihr-mandant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/webhooks',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://ihr-mandant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/webhooks`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://ihr-mandant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
}

response = requests.get(f'{base_url}/api/v1/webhooks', headers=headers)
data = response.json()
print(data)

Beispiel-Antwort

200 OK

{
    "data": [
        {
            "id": 1,
            "name": "string",
            "url": "string",
            "events": [],
            "is_active": true,
            "retry_count": 1,
            "timeout_seconds": 1,
            "last_triggered_at": "2026-01-15T10:00:00+01:00",
            "last_success_at": "2026-01-15T10:00:00+01:00",
            "last_failure_at": "2026-01-15T10:00:00+01:00",
            "failure_count": 1,
            "secret": "string",
            "created_at": "2026-01-15T10:00:00+01:00"
        }
    ]
}

Zeitpläne Berichte