find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/thanks-io:thanks-io-webhook-events-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: thanks.io Webhook Events API
  description: Use the thanks.io API to send postcards, letters, notecards, windowless letters, and gift cards.
  contact:
    url: https://thanks.io
    email: support@thanks.io
  version: 1.0.0
servers:
- url: https://api.thanks.io/api/v2
  description: The main API server for thanks.io
security:
- bearerAuth: []
tags:
- name: Webhook Events
paths: {}
webhooks:
  orderItemStatusUpdate:
    post:
      tags:
      - Webhook Events
      summary: Order Item Status Change Webhook
      description: Sent when an order item changes status. The payload includes the recipient, order, and order item context for the affected mail piece.
      operationId: orderItemStatusUpdateWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  type: string
                  example: order_item.status_update
                event_id:
                  type: string
                  example: 7199e4e0-516b-11f0-ba5f-f135ea42fb62
                data:
                  $ref: '#/components/schemas/webhook-order-item-status-update-payload'
                timestamp:
                  type: integer
                  example: 1750818235
                date_time:
                  type: string
                  example: '2025-06-25 02:23:55'
              required:
              - event_type
              - event_id
              - data
              - timestamp
              - date_time
            example:
              event_type: order_item.status_update
              event_id: 7199e4e0-516b-11f0-ba5f-f135ea42fb62
              data:
                order_item.id: 2668662
                order_item.scans: null
                order_item.failure: null
                recipient.name: John Doe
                recipient.company: null
                recipient.address: 123 Fake St
                recipient.address2: null
                recipient.absentee_address: null
                recipient.city: Any Town
                recipient.province: NY
                recipient.postal_code: '12345'
                recipient.country: US
                recipient.email: null
                recipient.phone: null
                recipient.custom_1: Example Custom 1
                recipient.custom_2: Example Custom 2
                recipient.custom_3: Example Custom 3
                recipient.custom_4: Example Custom 4
                recipient.custom_5: Example Custom 5
                recipient.custom_6: Example Custom 6
                recipient.custom_7: Example Custom 7
                recipient.custom_8: Example Custom 8
                recipient.custom_9: Example Custom 9
                recipient.custom_10: Example Custom 10
                order.id: 42399
                order.sub_account_id: 5
                order.status: Printing
                order.metadata:
                  crm_deal_id: D-1042
                order_item.delivery_date: '2025-07-05'
                order_item.previous_status: null
                order_item.current_status: Processing
              timestamp: 1750818235
              date_time: '2025-06-25 02:23:55'
      responses:
        '200':
          description: Webhook received
  orderStatusUpdate:
    post:
      tags:
      - Webhook Events
      summary: Order Status Change Webhook
      description: Sent when an order changes status. The payload includes the affected order identifier and its updated status.
      operationId: orderStatusUpdateWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  type: string
                  example: order.status_update
                event_id:
                  type: string
                  example: a8a59df0-516d-11f0-9ca2-31daad0e4f7f
                data:
                  $ref: '#/components/schemas/webhook-order-status-update-payload'
                timestamp:
                  type: integer
                  example: 1750819187
                date_time:
                  type: string
                  example: '2025-06-25 02:39:47'
              required:
              - event_type
              - event_id
              - data
              - timestamp
              - date_time
            example:
              event_type: order.status_update
              event_id: a8a59df0-516d-11f0-9ca2-31daad0e4f7f
              data:
                order.id: 42401
                order.status: Printing
                order.previous_status: reviewing
                order.current_status: processing
                order.metadata:
                  crm_deal_id: D-1042
              timestamp: 1750819187
              date_time: '2025-06-25 02:39:47'
      responses:
        '200':
          description: Webhook received
  orderItemDelivered:
    post:
      tags:
      - Webhook Events
      summary: Order Item Delivered Webhook
      description: Sent when a mail piece is delivered. The payload includes the recipient, order, and order item state at delivery.
      operationId: orderItemDeliveredWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  type: string
                  example: order_item.delivered
                event_id:
                  type: string
                  example: 7199e4e0-516b-11f0-ba5f-f135ea42fb62
                data:
                  $ref: '#/components/schemas/webhook-order-item-delivered-payload'
                timestamp:
                  type: integer
                  example: 1750818235
                date_time:
                  type: string
                  example: '2025-06-25 02:23:55'
              required:
              - event_type
              - event_id
              - data
              - timestamp
              - date_time
            example:
              event_type: order_item.delivered
              event_id: 7199e4e0-516b-11f0-ba5f-f135ea42fb62
              data:
                order_item.id: 2668662
                order_item.scans: null
                order_item.failure: null
                recipient.name: John Doe
                recipient.company: null
                recipient.address: 123 Fake St
                recipient.address2: null
                recipient.absentee_address: null
                recipient.city: Any Town
                recipient.province: NY
                recipient.postal_code: '12345'
                recipient.country: US
                recipient.email: null
                recipient.phone: null
                recipient.custom_1: Example Custom 1
                recipient.custom_2: Example Custom 2
                recipient.custom_3: Example Custom 3
                recipient.custom_4: Example Custom 4
                recipient.custom_5: Example Custom 5
                recipient.custom_6: Example Custom 6
                recipient.custom_7: Example Custom 7
                recipient.custom_8: Example Custom 8
                recipient.custom_9: Example Custom 9
                recipient.custom_10: Example Custom 10
                order.id: 42399
                order.sub_account_id: 5
                order.status: Printing
                order.metadata:
                  crm_deal_id: D-1042
                order_item.delivery_date: '2025-07-05'
                order_item.previous_status: Shipped
                order_item.current_status: Delivered
              timestamp: 1750818235
              date_time: '2025-06-25 02:23:55'
      responses:
        '200':
          description: Webhook received
  qrCodeScanUpdate:
    post:
      tags:
      - Webhook Events
      summary: QR Code Scan Webhook
      description: Sent when a recipient scans a thanks.io QR code on a mailer. The payload includes the scan context plus the QR code destination URL.
      operationId: qrCodeScanUpdateWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  type: string
                  example: scans.scan_update
                event_id:
                  type: string
                  example: c4e1aa40-516a-11f0-94e9-4b4494619f64
                data:
                  $ref: '#/components/schemas/webhook-scan-update-payload'
                timestamp:
                  type: integer
                  example: 1750817946
                date_time:
                  type: string
                  example: '2025-06-25 02:19:06'
              required:
              - event_type
              - event_id
              - data
              - timestamp
              - date_time
            example:
              event_type: scans.scan_update
              event_id: c4e1aa40-516a-11f0-94e9-4b4494619f64
              data:
                order_item.id: 2668661
                order_item.scans: 4
                order_item.failure: null
                recipient.name: John Doe
                recipient.company: null
                recipient.address: 123 Fake St
                recipient.address2: null
                recipient.absentee_address: null
                recipient.city: Any Town
                recipient.province: NY
                recipient.postal_code: '12345'
                recipient.country: US
                recipient.email: null
                recipient.phone: null
                recipient.custom_1: Example Custom 1
                recipient.custom_2: Example Custom 2
                recipient.custom_3: Example Custom 3
                recipient.custom_4: Example Custom 4
                recipient.custom_5: Example Custom 5
                recipient.custom_6: Example Custom 6
                recipient.custom_7: Example Custom 7
                recipient.custom_8: Example Custom 8
                recipient.custom_9: Example Custom 9
                recipient.custom_10: Example Custom 10
                order.id: 42398
                order.sub_account_id: 5
                order.status: Fulfilled
                order.metadata:
                  crm_deal_id: D-1042
                order_item.delivery_date: '2025-06-05'
                order_item.current_status: Processing
                qrcode.url: https://www.google.com
              timestamp: 1750817946
              date_time: '2025-06-25 02:19:06'
      responses:
        '200':
          description: Webhook received
  scanBoardStatusUpdate:
    post:
      tags:
      - Webhook Events
      summary: Scan Board Stage Change Webhook
      description: 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.
      operationId: scanBoardStatusUpdateWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  type: string
                  example: scan_board.status_update
                event_id:
                  type: string
                  example: c4e1aa40-516a-11f0-94e9-4b4494619f64
                data:
                  $ref: '#/components/schemas/webhook-scan-board-status-update-payload'
                timestamp:
                  type: integer
                  example: 1750817946
                date_time:
                  type: string
                  example: '2025-06-25 02:19:06'
              required:
              - event_type
              - event_id
              - data
              - timestamp
              - date_time
            example:
              event_type: scan_board.status_update
              event_id: c4e1aa40-516a-11f0-94e9-4b4494619f64
              data:
                order_item.id: 2668661
                order_item.scans: 4
                order_item.failure: null
                recipient.name: John Doe
                recipient.company: null
                recipient.address: 123 Fake St
                recipient.address2: null
                recipient.city: Any Town
                recipient.province: NY
                recipient.postal_code: '12345'
                recipient.country: US
                recipient.email: null
                recipient.phone: null
                recipient.custom_1: Example Custom 1
                recipient.custom_2: Example Custom 2
                recipient.absentee_address: null
                recipient.custom_3: Example Custom 3
                recipient.custom_4: Example Custom 4
                recipient.custom_5: Example Custom 5
                recipient.custom_6: Example Custom 6
                recipient.custom_7: Example Custom 7
                recipient.custom_8: Example Custom 8
                recipient.custom_9: Example Custom 9
                recipient.custom_10: Example Custom 10
                order.id: 42398
                order.status: Fulfilled
                order.sub_account_id: null
                order.metadata:
                  crm_deal_id: D-1042
                order_item.delivery_date: '2025-06-05'
                scan_board.card_id: 1187
                scan_board.previous_status: new
                scan_board.current_status: contacted
                scan_board.last_scanned_at: '2025-06-24 23:19:06'
              timestamp: 1750817946
              date_time: '2025-06-25 02:19:06'
      responses:
        '200':
          description: Webhook received
components:
  schemas:
    webhook-order-status-update-payload:
      type: object
      properties:
        order.id:
          type: integer
          example: 42401
        order.status:
          type: string
          description: The order's status after the change, in the same display form used throughout the dashboard and the order endpoints.
          example: Printing
        order.previous_status:
          type:
          - string
          - 'null'
          description: The status the order moved from, in lower case. Null if the order had no status before the change.
          example: reviewing
        order.current_status:
          type: string
          description: The status the order moved to, in lower case. This is the same change reported by `order.status`, which gives the display form of the value.
          example: processing
        order.metadata:
          type:
          - object
          - 'null'
          description: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
          additionalProperties: true
          example:
            crm_deal_id: D-1042
      additionalProperties: false
    scan-board-status:
      type: string
      description: A QR Scan Board stage.
      enum:
      - new
      - contacted
      - follow_up
      - done
      example: contacted
    webhook-scan-update-payload:
      $ref: '#/components/schemas/webhook-data-flat'
    webhook-data-flat:
      type: object
      description: Flat payload object used by webhook events. Each property is a dotted key matching the published webhook payload structure.
      properties:
        order_item.id:
          type:
          - integer
          - 'null'
          example: 2668662
        order_item.scans:
          type:
          - integer
          - 'null'
          example: null
        order_item.failure:
          type:
          - string
          - 'null'
          example: null
        recipient.name:
          type:
          - string
          - 'null'
          example: John Doe
        recipient.company:
          type:
          - string
          - 'null'
          example: null
        recipient.address:
          type:
          - string
          - 'null'
          example: 123 Fake St
        recipient.address2:
          type:
          - string
          - 'null'
          example: null
        recipient.absentee_address:
          type:
          - string
          - 'null'
          example: null
        recipient.city:
          type:
          - string
          - 'null'
          example: Any Town
        recipient.province:
          type:
          - string
          - 'null'
          example: NY
        recipient.postal_code:
          type:
          - string
          - 'null'
          example: '12345'
        recipient.country:
          type:
          - string
          - 'null'
          example: US
        recipient.email:
          type:
          - string
          - 'null'
          example: null
        recipient.phone:
          type:
          - string
          - 'null'
          example: null
        recipient.custom_1:
          type:
          - string
          - 'null'
          example: Example Custom 1
        recipient.custom_2:
          type:
          - string
          - 'null'
          example: Example Custom 2
        recipient.custom_3:
          type:
          - string
          - 'null'
          example: Example Custom 3
        recipient.custom_4:
          type:
          - string
          - 'null'
          example: Example Custom 4
        recipient.custom_5:
          type:
          - string
          - 'null'
          example: Example Custom 5
        recipient.custom_6:
          type:
          - string
          - 'null'
          example: Example Custom 6
        recipient.custom_7:
          type:
          - string
          - 'null'
          example: Example Custom 7
        recipient.custom_8:
          type:
          - string
          - 'null'
          example: Example Custom 8
        recipient.custom_9:
          type:
          - string
          - 'null'
          example: Example Custom 9
        recipient.custom_10:
          type:
          - string
          - 'null'
          example: Example Custom 10
        order.id:
          type:
          - integer
          - 'null'
          example: 42399
        order.sub_account_id:
          type:
          - integer
          - 'null'
          example: 5
        order.status:
          type:
          - string
          - 'null'
          example: Printing
        order_item.delivery_date:
          type:
          - string
          - 'null'
          example: '2025-07-05'
        order_item.previous_status:
          type:
          - string
          - 'null'
          example: null
        order_item.current_status:
          type:
          - string
          - 'null'
          example: Processing
        qrcode.url:
          type:
          - string
          - 'null'
          format: uri
          example: https://www.google.com
        order.metadata:
          type:
          - object
          - 'null'
          description: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
          additionalProperties: true
          example:
            crm_deal_id: D-1042
      additionalProperties: false
    webhook-order-item-status-update-payload:
      $ref: '#/components/schemas/webhook-data-flat'
    webhook-order-item-delivered-payload:
      $ref: '#/components/schemas/webhook-data-flat'
    webhook-scan-board-status-update-payload:
      allOf:
      - $ref: '#/components/schemas/webhook-data-flat'
      - type: object
        properties:
          scan_board.card_id:
            type: integer
            description: The ID of the card on your Scan Board.
            example: 1187
          scan_board.previous_status:
            type:
            - string
            - 'null'
            description: The stage the card left. null for a new card.
            enum:
            - new
            - contacted
            - follow_up
            - done
            - null
            example: new
          scan_board.current_status:
            $ref: '#/components/schemas/scan-board-status'
          scan_board.last_scanned_at:
            type:
            - string
            - 'null'
            description: When the mailer was last scanned.
            example: '2025-06-24 23:19:06'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication using your thanks.io API key
externalDocs:
  description: Learn more about thanks.io
  url: https://docs.thanks.io
x-mint:
  mcp:
    enabled: true
x-mcp:
  enabled: true