Het afleveringslogboek van de webhook
- In de sandbox
Sinds 0.28.0. De afleveringen van één webhook, nieuwste poging eerst (nooit geprobeerde als laatste), met per aflevering de status, de mislukkingen en de tijden, en niet de gebeurtenis zelf. Een sleutel van een eindklant met de scope read leest de webhook van die eindklant (een andere eindklant noemen geeft 404); de sleutel van de beheerder leest de eigen webhook van de beheerder, of die van één eindklant met client; de alleen-lezen beheerderssleutel leest hetzelfde. Ten hoogste limit rijen (standaard 100, ten hoogste 500), met truncated als er meer zijn.
apiKeyAuthorizationBearer <token>Stuur uw sleutel als bearer-token: Authorization: Bearer <your-api-key>. De health-aanroep is de enige aanroep die geen sleutel vereist.
client?string^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$state?string"pending""delivered""dead"limit?integer1 <= value <= 500100De afleveringen.
application/json- response
data*array<>truncated*booleancurl -X GET "https://example.com/webhook/deliveries" \ -H "Authorization: Bearer <your-api-key>"{ "data": [ { "invoice_id": "string", "sequence": 0, "event_id": "string", "state": "pending", "failures": 0, "first_failure_at": "2019-08-24T14:15:22Z", "last_attempt_at": "2019-08-24T14:15:22Z" } ], "truncated": true}De webhookinstellingen opvragen (die van de beheerder, of met de beheerderssleutel van een eindklant die van die eindklant) GET
Sinds 0.16.0 leest de sleutel van de beheerder de instellingen van één eindklant met client. Een beheerderssleutel van een eindklant mag alleen de eigen eindklant noemen; elke andere geeft 404. Een onbekende of herhaalde parameter, of een lege client, geeft 400. Een webhook instellen en testen accepteert helemaal geen queryparameters (400): die blijven bij de eigen sleutel van de webhook.
De webhook-URL instellen, of het geheim vernieuwen PUT
De sleutel van de beheerder stelt de webhook van de beheerder in, die de berichten van alle eindklanten krijgt; de beheerderssleutel van een eindklant stelt die van de eigen eindklant in, die alleen zijn berichten krijgt. De eerste aanroep heeft url nodig en maakt het geheim aan, dat eenmalig wordt teruggegeven. Vernieuwen geeft het nieuwe geheim eenmalig terug. Gedurende 24 uur ondertekent de dienst elke aflevering met zowel het nieuwe als het oude geheim, zodat de partner kan overstappen zonder berichten te verliezen. Alleen berichten die na de eerste aanroep zijn geschreven, worden afgeleverd. De URL moet https zijn, en elk adres waarnaar de host verwijst, moet openbaar zijn: loopback-, privé-, link-local-, carrier-grade-NAT-, multicast-, gereserveerde en cloudmetadata-adressen worden geweigerd, hier en opnieuw vóór elke aflevering. Doorverwijzingen worden niet gevolgd. Sinds 0.16.0 geeft elke queryparameter 400, zodat een verkeerd gespelde client de eigen webhook van de beheerder nooit kan wijzigen.