Webhooks class

The webhook (IPN) of the key's mode: a test key manages the test webhook, a live key the live one. A storefront's key may read and test it, not change it.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

constructEvent(Object payload, String? signatureHeader, {String? secret, Duration tolerance = Webhook.defaultTolerance}) → WebhookEvent

Verifies a webhook request and returns its event; see Webhook.constructEvent. secret defaults to the client's webhookSecret; without either it throws SignatureVerificationException.

get() → Future<WebhookSettings>

The webhook: its URL (null when not set) and its signing secret.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

remove() → Future<WebhookSettings>

Stops POSTing to the URL (payments with their own webhook URL still get theirs); the secret stays.

set(String url) → Future<WebhookSettings>

Sets the URL every event of the mode is POSTed to: https, on a public host, accepting POST requests. Safe to retry.

test() → Future<WebhookDelivery>

Queues a signed ping event to the URL and returns its delivery.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

events → const List<String>

The events payitgo sends. A test (test) sends ping.