tys.webhooks.generateTestHeader()

Method@tryyoursize/node

Builds a valid TYS-Signature header for a payload, to test your webhook handler.

generateTestHeader(opts: Parameters<typeof generateTestHeader>[0]): string

Parameters

optsParameters<typeof generateTestHeader>[0]Required

{ payload, secret, timestamp? }: the body, the secret (or several, as during a rotation) and the unix time (default now).

Returns

string: The header value: t=<unix>,v1=<hex>.

Example

Node.jsPython

const payload = JSON.stringify({ id: "evt_test", object: "event", type: "webhook.test", data: {} });
const header = tys.webhooks.generateTestHeader({ payload, secret: "whsec_test" });
await fetch("http://localhost:3000/webhooks/tryyoursize", {
  method: "POST",
  headers: { "TYS-Signature": header, "Content-Type": "application/json" },
  body: payload,
});

payload = json.dumps({"id": "evt_test", "object": "event", "type": "webhook.test", "data": {}})
header = tryyoursize.Webhook.generate_test_header(payload, "whsec_test")