Webhooks

7 endpoint

Le descrizioni degli endpoint provengono direttamente dall'API e sono in tedesco.

Webhook-Endpunkte

get/v1/webhook_endpoints

Empfänger für Ereignisse.

Risposta 200WebhookEndpointList

Nome	Tipo	Descrizione
`object`obbligatorio	"list"
`data`obbligatorio	WebhookEndpoint[]
`has_more`obbligatorio	boolean

Errori possibili

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

Esempio

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

Risposta 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.

Parametri

Nome	Posizione	Tipo
`idempotency-key`facoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Intestazione	string

Richiesta

Nome	Tipo	Descrizione
`url`obbligatorio	string (uri)
`description`facoltativo	string \| null
`events`facoltativo	"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`facoltativo	boolean

Risposta 201WebhookEndpoint

Nome	Tipo	Descrizione
`id`obbligatorio	string	ID mit Präfix «whk_»
`object`obbligatorio	"webhook_endpoint"
`livemode`obbligatorio	boolean
`url`obbligatorio	string
`description`obbligatorio	string \| null
`events`obbligatorio	string[]
`enabled`obbligatorio	boolean
`secret`facoltativo	string	Nur beim Anlegen oder Rotieren sichtbar
`created_at`obbligatorio	string

Errori possibili

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

Esempio

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}'

Risposta 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`.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Richiesta

Nome	Tipo	Descrizione
`url`facoltativo	string (uri)
`description`facoltativo	string \| null
`events`facoltativo	"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`facoltativo	boolean
`rotate_secret`facoltativo	boolean

Risposta 200WebhookEndpoint

Nome	Tipo	Descrizione
`id`obbligatorio	string	ID mit Präfix «whk_»
`object`obbligatorio	"webhook_endpoint"
`livemode`obbligatorio	boolean
`url`obbligatorio	string
`description`obbligatorio	string \| null
`events`obbligatorio	string[]
`enabled`obbligatorio	boolean
`secret`facoltativo	string	Nur beim Anlegen oder Rotieren sichtbar
`created_at`obbligatorio	string

Errori possibili

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

Esempio

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}'

Risposta 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.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Risposta 200Deleted

Nome	Tipo	Descrizione
`id`obbligatorio	string
`object`obbligatorio	string
`deleted`obbligatorio	true

Errori possibili

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

Esempio

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

Risposta 200

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

Zustellprotokoll

get/v1/webhook_endpoints/{id}/deliveries

Letzte 100 Zustellungen mit Antwortcode.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Risposta 200Object

Errori possibili

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

Esempio

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

Risposta 200

{}

Ereignisse

get/v1/events

Alle Ereignisse, neueste zuerst.

Parametri

Nome	Posizione	Tipo
`limit`facoltativo	Query	integer
`starting_after`facoltativo	Query	string
`type`facoltativo	Query	string

Risposta 200EventList

Nome	Tipo	Descrizione
`object`obbligatorio	"list"
`data`obbligatorio	Event[]
`has_more`obbligatorio	boolean

Errori possibili

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

Esempio

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

Risposta 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.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string
`idempotency-key`facoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Intestazione	string

Risposta 200Object

Errori possibili

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

Esempio

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

Risposta 200

{}