sendPartnerWebhookTest method

Future<WebhookTestErgebnis> sendPartnerWebhookTest(String webhookId, { String? event, })

Schickt eine Probe an genau diesen Endpunkt.

Ohne event kommt webhook.test -- der Nachweis, dass die Leitung steht und die eigene Signaturpruefung gegen echte Bytes laeuft. Mit event kommt genau das Ereignis, das der Empfaenger behandeln soll, mit einer glaubwuerdigen Nutzlast: wer auf signature.ready hin seinen Kunden benachrichtigt, probt das einmal, statt auf eine echte Karte zu warten. Eine Leitungsprobe beweist nichts ueber die Behandlung des Ernstfalls.

Der Endpunkt muss das Ereignis abonnieren (event_not_subscribed) und aktiv sein (webhook_inactive); ein unbekannter Name ist ein validation-Fehler auf dem Feld event.

Jede Probe traegt test: true im Umschlag (PartnerWebhookEreignis.test).

Der Backend-Endpunkt heisst sendPartnerWebhookTest; dieser Client behaelt den Namen bei, damit ein Leser der Doku und ein Leser des Codes dasselbe suchen.

Implementation

Future<WebhookTestErgebnis> sendPartnerWebhookTest(String webhookId, {String? event}) async {
  final id = _pflicht(webhookId, 'sendPartnerWebhookTest', 'webhookId');
  final ereignis = (event ?? '').trim();
  final d = await _t.rufen(Aufrufe.sendPartnerWebhookTest, params: <String, dynamic>{
    'webhookId': id,
    'event': ereignis.isEmpty ? null : ereignis,
  });
  return WebhookTestErgebnis(
    eventId: alsText(d['eventId']),
    ereignis: alsText(d['ereignis'], ereignis.isEmpty ? 'webhook.test' : ereignis),
    zustellungen: alsListe(d['deliveries']),
  );
}