shift.cancelled

A shift is cancelled because its support or group support is cancelled, including each shift of a recurring cancellation. Cancelling one participant of a group support that goes ahead sends nothing, and so does reinstating a cancelled support or group support.

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

Example payload

{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "event_type": "shift.cancelled",
  "resource": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "type": "shift"
  },
  "data": []
}

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:shift.cancelled
resourceobjectrequired
The record the event relates to.
▶Show 2 child attributesHide child attributes
- idstring<uuid>required
  The ID of the shift.
- typeenum<string>required
  Available options:shift
dataany[]required
Always empty for this event. Fetch the record from the API for its current details.

Fetch the record

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

getGet a Shift/public/v1/shifts/{shift}

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.