user_record.expiring

A user record is coming up to its expiry date. Sent 30, 14, 7 and 1 days before it, at 9am in your account's timezone; `data.reminder_days` says which reminder this is and `data.days_until_expiry` how many days are left. A record that first comes within 30 days late gets only the latest reminder due, then the later ones.

postAstalty sends a POST to each webhook subscribed to this event.

Example payload

{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "event_type": "user_record.expiring",
  "resource": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "type": "user_record"
  },
  "data": {
    "reminder_days": 30,
    "days_until_expiry": 1
  }
}

Verify the signature

import crypto from "node:crypto";

export function isFromAstalty(rawBody, signature, signingSecret) {
  const expected = crypto
    .createHmac("sha256", signingSecret)
    .update(rawBody)
    .digest("hex");

  return (
    typeof signature === "string" &&
    signature.length === expected.length &&
    crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature))
  );
}

Headers

X-Astalty-Signaturestringrequired
HMAC-SHA256 of the raw request body, keyed with the webhook's signing secret and hex encoded. See Verifying the signature.

Payload

application/json

idstring<uuid>required
The delivery ID. It stays the same across retries, so use it to ignore a delivery you have already processed.
event_typeenum<string>required
The event that occurred.
Available options:user_record.expiring
resourceobjectrequired
The record the event relates to.
▶Show 2 child attributesHide child attributes
- idstring<uuid>required
  The ID of the user record.
- typeenum<string>required
  Available options:user_record
dataobjectrequired
▶Show 2 child attributesHide child attributes
- reminder_daysenum<integer>required
  Which reminder this is: the number of days before the expiry date it is scheduled for.
  Available options:301471
- days_until_expiryintegerrequired
  Whole days from today to the expiry date, in your account's timezone. Lower than reminder_days when the record came within the window after that reminder was due.

Fetch the record

The payload names the record but does not include it. Call this endpoint with resource.id to read its current details.

getShow a User Record/public/v1/user-records/{userRecord}

Responding

Return any 2xx status within 15 seconds to acknowledge the delivery. Anything else is retried up to 10 times over about 42 hours, so make your handler idempotent on the delivery id. See Retries and delivery.