Webhooks

7 endpoints

Les descriptions des endpoints proviennent directement de l'API et sont en allemand.

Webhook-Endpunkte

get/v1/webhook_endpoints

Empfänger für Ereignisse.

Réponse 200WebhookEndpointList

Nom	Type	Description
`object`obligatoire	"list"
`data`obligatoire	WebhookEndpoint[]
`has_more`obligatoire	boolean

Erreurs possibles

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

Exemple

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

Réponse 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.

Paramètres

Nom	Emplacement	Type
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Requête

Nom	Type	Description
`url`obligatoire	string (uri)
`description`facultatif	string \| null
`events`facultatif	"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`facultatif	boolean

Réponse 201WebhookEndpoint

Nom	Type	Description
`id`obligatoire	string	ID mit Präfix «whk_»
`object`obligatoire	"webhook_endpoint"
`livemode`obligatoire	boolean
`url`obligatoire	string
`description`obligatoire	string \| null
`events`obligatoire	string[]
`enabled`obligatoire	boolean
`secret`facultatif	string	Nur beim Anlegen oder Rotieren sichtbar
`created_at`obligatoire	string

Erreurs possibles

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

Exemple

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

Réponse 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`.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Requête

Nom	Type	Description
`url`facultatif	string (uri)
`description`facultatif	string \| null
`events`facultatif	"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`facultatif	boolean
`rotate_secret`facultatif	boolean

Réponse 200WebhookEndpoint

Nom	Type	Description
`id`obligatoire	string	ID mit Präfix «whk_»
`object`obligatoire	"webhook_endpoint"
`livemode`obligatoire	boolean
`url`obligatoire	string
`description`obligatoire	string \| null
`events`obligatoire	string[]
`enabled`obligatoire	boolean
`secret`facultatif	string	Nur beim Anlegen oder Rotieren sichtbar
`created_at`obligatoire	string

Erreurs possibles

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

Exemple

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

Réponse 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.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200Deleted

Nom	Type	Description
`id`obligatoire	string
`object`obligatoire	string
`deleted`obligatoire	true

Erreurs possibles

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

Exemple

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

Réponse 200

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

Zustellprotokoll

get/v1/webhook_endpoints/{id}/deliveries

Letzte 100 Zustellungen mit Antwortcode.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200Object

Erreurs possibles

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

Exemple

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

Réponse 200

{}

Ereignisse

get/v1/events

Alle Ereignisse, neueste zuerst.

Paramètres

Nom	Emplacement	Type
`limit`facultatif	Requête	integer
`starting_after`facultatif	Requête	string
`type`facultatif	Requête	string

Réponse 200EventList

Nom	Type	Description
`object`obligatoire	"list"
`data`obligatoire	Event[]
`has_more`obligatoire	boolean

Erreurs possibles

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

Exemple

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

Réponse 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.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Réponse 200Object

Erreurs possibles

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

Exemple

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

Réponse 200

{}