Webhooks

List Webhooks

Changed on

Return a paginated list of configured webhooks. Webhooks are available on paid subscriptions only.

get/webhooks

Request

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

Query parameters

items_per_pageinteger

Number of items to return per page.

type'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update'
Example:order_item.status_update

Only return webhooks of this type.

scan_board_status'new' | 'contacted' | 'follow_up' | 'done'

A QR Scan Board stage.

Example:contacted

Only return Scan Board stage webhooks set to this stage.

Response

OK

can_manage_webhooksboolean

Example response

{
  "data": [
    {
      "id": 11,
      "user_id": 2,
      "mailing_list_id": 1,
      "type": "order_item.status_update",
      "description": "Webhook for order item status updates",
      "url": "https://example.com/webhooks/thanksio",
      "verb": "post",
      "created_at": "2026-03-02T02:10:29.000000Z",
      "updated_at": "2026-03-10T17:45:02.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "can_manage_webhooks": true
}

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 query request parameter scan_board_status

    • info

      added the new optional query request parameter type

    • info

      added the optional property // to the response with the status

  • bbe02ffe74f3Revision changes
    • warning

      deleted the query request parameter scan_board_status

    • warning

      deleted the query request parameter type

    • 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