Webhooks

Create Webhook

Changed on

Create a webhook destination. Webhooks are available on paid subscriptions only.

post/webhooks

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
type'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update' required
scan_board_status'new' | 'contacted' | 'follow_up' | 'done' | 'null' nullable

The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.

descriptionstring nullable
verbstring required
mailing_list_idinteger nullable

Example request

{
  "url": "https://example.com/webhooks/thanksio",
  "type": "order_item.status_update",
  "description": "Order status updates",
  "verb": "post"
}

Response

Created

type'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update'
scan_board_status'new' | 'contacted' | 'follow_up' | 'done' | 'null' nullable

The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.

urlstring uri
descriptionstring nullable
verbstring
mailing_list_idinteger nullable
user_idinteger
invoke_countinteger
updated_atstring date-time
created_atstring date-time
idinteger

Example response

{
  "type": "order_item.status_update",
  "url": "https://example.com/webhooks/thanksio",
  "description": "Order status updates",
  "verb": "post",
  "user_id": 2,
  "updated_at": "2026-03-10T18:59:24.000000Z",
  "created_at": "2026-03-10T18:59:24.000000Z",
  "id": 13
}

Changes

  • 6a3359b14347Revision changes
    • warning

      added the new scan_board.status_update enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new scan_board.status_update enum value to the request property

    • info

      added the optional property to the response with the status

  • bbe02ffe74f3Revision changes
    • breaking

      removed the enum value scan_board.status_update of the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      removed the scan_board.status_update enum value from the response property for the response status