---
title: "Scan Board Stage Change Webhook"
method: POST
path: "scanBoardStatusUpdate"
tags: ["Webhook Events"]
---

# Scan Board Stage Change Webhook

`POST scanBoardStatusUpdate` (webhook)

Sent when a card on your QR Scan Board enters the stage set in the webhook's scan_board_status, including when a newly scanned mailer lands in New. Each webhook fires at most once per card per stage. Available on the Business plan and up.

## Payload

- object
  - `event_type` string, required
  - `event_id` string, required
  - `data` WebhookScanBoardStatusUpdatePayload, required: Flat payload object used by webhook events. Each property is a dotted key matching the published webhook payload structure.
    - `order_item.id` integer, nullable
    - `order_item.scans` integer, nullable
    - `order_item.failure` string, nullable
    - `recipient.name` string, nullable
    - `recipient.company` string, nullable
    - `recipient.address` string, nullable
    - `recipient.address2` string, nullable
    - `recipient.absentee_address` string, nullable
    - `recipient.city` string, nullable
    - `recipient.province` string, nullable
    - `recipient.postal_code` string, nullable
    - `recipient.country` string, nullable
    - `recipient.email` string, nullable
    - `recipient.phone` string, nullable
    - `recipient.custom_1` string, nullable
    - `recipient.custom_2` string, nullable
    - `recipient.custom_3` string, nullable
    - `recipient.custom_4` string, nullable
    - `recipient.custom_5` string, nullable
    - `recipient.custom_6` string, nullable
    - `recipient.custom_7` string, nullable
    - `recipient.custom_8` string, nullable
    - `recipient.custom_9` string, nullable
    - `recipient.custom_10` string, nullable
    - `order.id` integer, nullable
    - `order.sub_account_id` integer, nullable
    - `order.status` string, nullable
    - `order_item.delivery_date` string, nullable
    - `order_item.previous_status` string, nullable
    - `order_item.current_status` string, nullable
    - `qrcode.url` string, uri, nullable
    - `order.metadata` object, nullable: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
    - `scan_board.card_id` integer: The ID of the card on your Scan Board.
    - `scan_board.previous_status` 'new' | 'contacted' | 'follow_up' | 'done' | 'null', nullable: The stage the card left. null for a new card.
    - `scan_board.current_status` 'new' | 'contacted' | 'follow_up' | 'done': A QR Scan Board stage.
    - `scan_board.last_scanned_at` string, nullable: When the mailer was last scanned.
  - `timestamp` integer, required
  - `date_time` string, required

## Acknowledgement `200`

Webhook received

---

[API](https://skmtc.dev/thanks-io/apis/thanks-io-api.md) · [All operations](https://skmtc.dev/thanks-io/apis/thanks-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thanks-io/apis/thanks-io-api/revisions/c403fbf3dc0f?raw)