Basis-URL
https://{tenant}.logzi.com/api/integration_webhook/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Die Webhook-Einträge speichern die an die Integration zu sendenden Ereignisbenachrichtigungen (z. B. neue Bestellung, Rechnungsausstellung). Das Feld sended zeigt an, ob der Webhook bereits gesendet wurde.
/api/integration_webhook/get
Abrufen eines einzelnen Webhook-Eintrags anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des Webhook-Eintrags |
Beispielanfrage
GET /api/integration_webhook/get?id=200
X-API-KEY: {ihr_api_schluessel}/api/integration_webhook/list
Abrufen einer paginierbaren Liste von Webhook-Einträgen.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/integration_webhook/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/integration_webhook/save
Erstellen oder Ändern eines Webhook-Eintrags. Bei einer Änderung kann nur das Feld sended aktualisiert werden. Für einen neuen Eintrag data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neuer Eintrag, >0 = Änderung (Aktualisierung von sended) | |
integration_id | int | ID der Integration | |
integration_webhook_type_id | int | Typ des Webhook-Ereignisses | |
receipt_id | int | ID des zugehörigen Belegs | |
receipt_type_id | int | Belegtyp | |
product_id | int | ID des zugehörigen Produkts | |
request | string | Inhalt der gesendeten Anfrage (JSON) | |
request_url | string | URL der Anfrage | |
response | string | Inhalt der erhaltenen Antwort | |
sended | int | 1 = gesendet (bei Änderung) |
Beispielanfrage
POST /api/integration_webhook/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"integration_id": 1,
"integration_webhook_type_id": 3,
"receipt_id": 150,
"receipt_type_id": 2
}
}/api/integration_webhook/delete
Löschen eines Webhook-Eintrags anhand der ID.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des zu löschenden Webhooks |
Beispielanfrage
POST /api/integration_webhook/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 200 } }/api/integration_webhook/close
Abschließen eines Webhook-Eintrags — Markierung als gesendet und Erfassung der Antwortdaten.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des abzuschließenden Webhooks | |
response | string | Inhalt der erhaltenen Antwort | |
response_http_code | string | HTTP-Statuscode |
Beispielanfrage
POST /api/integration_webhook/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 200, "response_http_code": "200" } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
