Webhooks

7 Endpunkte

Webhook-Endpunkte

get/v1/webhook_endpoints

Empfänger für Ereignisse.

Antwort 200WebhookEndpointList

Name	Typ	Beschreibung
`object`Pflicht	"list"
`data`Pflicht	WebhookEndpoint[]
`has_more`Pflicht	boolean

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X GET https://api.ladehase.com/v1/webhook_endpoints \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "whk_2f4a6c8e0b1d3f5a",
      "object": "webhook_endpoint",
      "livemode": true,
      "url": "string",
      "description": "string",
      "events": [
        "string"
      ],
      "enabled": true,
      "secret": "string",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Webhook anlegen

post/v1/webhook_endpoints

Signatur `Ladehase-Signature: t=…,v1=…` (HMAC-SHA256 über `t.body`). Das Geheimnis ist nur in dieser Antwort sichtbar.

Parameter

Name	Ort	Typ
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Kopfzeile	string

Anfrage

Name	Typ	Beschreibung
`url`Pflicht	string (uri)
`description`optional	string \| null
`events`optional	"session.created" \| "session.started" \| "session.updated" \| "session.stopped" \| "session.settled" \| "session.failed" \| "payment.authorized" \| "payment.captured" \| "payment.released" \| "payment.refunded" \| "device.online" \| "device.offline" \| "device.error" \| "terminal.online" \| "terminal.offline" \| "integration.error" \| "*"[]
`enabled`optional	boolean

Antwort 201WebhookEndpoint

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «whk_»
`object`Pflicht	"webhook_endpoint"
`livemode`Pflicht	boolean
`url`Pflicht	string
`description`Pflicht	string \| null
`events`Pflicht	string[]
`enabled`Pflicht	boolean
`secret`optional	string	Nur beim Anlegen oder Rotieren sichtbar
`created_at`Pflicht	string

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X POST https://api.ladehase.com/v1/webhook_endpoints \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"url":"https://example.ch/webhooks/ladehase","description":"string","events":["*"],"enabled":true}'

Antwort 201

{
  "id": "whk_2f4a6c8e0b1d3f5a",
  "object": "webhook_endpoint",
  "livemode": true,
  "url": "string",
  "description": "string",
  "events": [
    "string"
  ],
  "enabled": true,
  "secret": "string",
  "created_at": "string"
}

Webhook ändern

patch/v1/webhook_endpoints/{id}

Auch `rotate_secret`.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Anfrage

Name	Typ	Beschreibung
`url`optional	string (uri)
`description`optional	string \| null
`events`optional	"session.created" \| "session.started" \| "session.updated" \| "session.stopped" \| "session.settled" \| "session.failed" \| "payment.authorized" \| "payment.captured" \| "payment.released" \| "payment.refunded" \| "device.online" \| "device.offline" \| "device.error" \| "terminal.online" \| "terminal.offline" \| "integration.error" \| "*"[]
`enabled`optional	boolean
`rotate_secret`optional	boolean

Antwort 200WebhookEndpoint

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «whk_»
`object`Pflicht	"webhook_endpoint"
`livemode`Pflicht	boolean
`url`Pflicht	string
`description`Pflicht	string \| null
`events`Pflicht	string[]
`enabled`Pflicht	boolean
`secret`optional	string	Nur beim Anlegen oder Rotieren sichtbar
`created_at`Pflicht	string

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X PATCH https://api.ladehase.com/v1/webhook_endpoints/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"url":"https://example.ch/webhooks/ladehase","description":"string","events":["*"],"enabled":true,"rotate_secret":true}'

Antwort 200

{
  "id": "whk_2f4a6c8e0b1d3f5a",
  "object": "webhook_endpoint",
  "livemode": true,
  "url": "string",
  "description": "string",
  "events": [
    "string"
  ],
  "enabled": true,
  "secret": "string",
  "created_at": "string"
}

Webhook löschen

delete/v1/webhook_endpoints/{id}

Keine weiteren Zustellungen.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Antwort 200Deleted

Name	Typ	Beschreibung
`id`Pflicht	string
`object`Pflicht	string
`deleted`Pflicht	true

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X DELETE https://api.ladehase.com/v1/webhook_endpoints/{id} \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "id": "string",
  "object": "string",
  "deleted": true
}

Zustellprotokoll

get/v1/webhook_endpoints/{id}/deliveries

Letzte 100 Zustellungen mit Antwortcode.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Antwort 200Object

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X GET https://api.ladehase.com/v1/webhook_endpoints/{id}/deliveries \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{}

Ereignisse

get/v1/events

Alle Ereignisse, neueste zuerst.

Parameter

Name	Ort	Typ
`limit`optional	Abfrage	integer
`starting_after`optional	Abfrage	string
`type`optional	Abfrage	string

Antwort 200EventList

Name	Typ	Beschreibung
`object`Pflicht	"list"
`data`Pflicht	Event[]
`has_more`Pflicht	boolean

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X GET https://api.ladehase.com/v1/events \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "evt_1b3d5f7a9c0e2f4b",
      "object": "event",
      "type": "string",
      "livemode": true,
      "data": {},
      "created_at": "string"
    }
  ],
  "has_more": true
}

Ereignis erneut senden

post/v1/events/{id}/resend

An alle passenden Endpunkte.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Kopfzeile	string

Antwort 200Object

Mögliche Fehler

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Beispiel

curl -X POST https://api.ladehase.com/v1/events/{id}/resend \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{}