De webhookinstellingen opvragen (die van de beheerder, of met de beheerderssleutel van een eindklant die van die eindklant)
- In de sandbox
In gewone woorden
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.
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?stringDe keuze van de beheerder voor een eindklant. Een andere vorm geeft 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$De huidige instellingen. Het geheim wordt nooit teruggegeven. Zonder instelling is url null en active false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Wie op de hoogte moet worden gebracht als afleveringen mislukken.
last_delivery?|nullcurl -X GET "https://example.com/webhook" \ -H "Authorization: Bearer <your-api-key>"{ "url": "http://example.com", "active": true, "secret_rotated_at": "2019-08-24T14:15:22Z", "contact_email": "string", "last_delivery": { "at": "2019-08-24T14:15:22Z", "http_status": 0 }}Een document opbouwen en controleren zonder het te verzenden POST
Voert het schema, de voorafgaande controles, de serializer voor het verzendkanaal en elke officiële validatielaag uit, en geeft dan het rapport en de documenten die het heeft opgebouwd terug, elk met zijn bytes in content_base64 als het 2 MiB of kleiner is. Er wordt niets verzonden en niets bewaard behalve het verzoeklogboek. Gebruik het tijdens het mappen van een nieuwe eindklant. Een getal buiten de grenzen (zie de conventies) geeft 422 voordat een controle draait.
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.