Interface VerifiedWebhook

A delivery that passed verification.

interface VerifiedWebhook {
    event: KnownEvent | UnknownEvent;
    id: string;
    scheme: "v1a" | "v1";
    syncEpoch: string | undefined;
    timestamp: number;
}

Properties

The envelope decoded by type alone (decodeEvent); a body that is no JSON is an UnknownEvent with type "" and no raw value.

id: string

The webhook-id, equal to the event ID; the key for the app's duplicate check.

scheme: "v1a" | "v1"

The scheme of the first valid entry of webhook-signature.

syncEpoch: string | undefined

The delivery member sync_epoch when it is a string; a change means the instance was restored (docs/api/webhooks.md 3 point 6).

timestamp: number

The webhook-timestamp, Unix seconds of this attempt.