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-webhooks-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 Webhooks 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: Webhooks
paths:
  /webhooks:
    get:
      tags:
      - Webhooks
      summary: List Webhooks
      description: Return a paginated list of configured webhooks. Webhooks are available on paid subscriptions only.
      parameters:
      - $ref: '#/components/parameters/items_per_page'
      - name: type
        in: query
        description: Only return webhooks of this type.
        required: false
        schema:
          $ref: '#/components/schemas/webhook-type'
      - name: scan_board_status
        in: query
        description: Only return Scan Board stage webhooks set to this stage.
        required: false
        schema:
          $ref: '#/components/schemas/scan-board-status'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 11
                        user_id:
                          type: integer
                          example: 2
                        mailing_list_id:
                          type:
                          - integer
                          - 'null'
                          example: 1
                        type:
                          $ref: '#/components/schemas/webhook-type'
                        scan_board_status:
                          type:
                          - string
                          - 'null'
                          enum:
                          - new
                          - contacted
                          - follow_up
                          - done
                          - null
                          description: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
                          example: null
                        description:
                          type:
                          - string
                          - 'null'
                          example: Webhook for order item status updates
                        invoke_count:
                          type: integer
                          example: 0
                        url:
                          type: string
                          format: uri
                          example: https://example.com/webhooks/thanksio
                        verb:
                          type: string
                          example: post
                        created_at:
                          type:
                          - string
                          - 'null'
                          format: date-time
                          example: '2026-03-02T02:10:29.000000Z'
                        updated_at:
                          type: string
                          format: date-time
                          example: '2026-03-10T17:45:02.000000Z'
                        deleted_at:
                          type:
                          - string
                          - 'null'
                          format: date-time
                          example: null
                  links:
                    $ref: '#/components/schemas/links'
                  meta:
                    $ref: '#/components/schemas/meta'
                  can_manage_webhooks:
                    type: boolean
                    example: true
              example:
                data:
                - id: 11
                  user_id: 2
                  mailing_list_id: 1
                  type: order_item.status_update
                  description: Updated webhook destination
                  invoke_count: 0
                  url: https://example.com/webhooks/thanksio-updated
                  verb: get
                  created_at: '2026-03-02T02:10:33.000000Z'
                  updated_at: '2026-03-02T02:23:27.000000Z'
                  deleted_at: null
                - id: 10
                  user_id: 2
                  mailing_list_id: null
                  type: order.status_update
                  description: Order status updates
                  invoke_count: 70
                  url: https://example.com/webhooks/thanksio
                  verb: post
                  created_at: '2026-03-02T02:10:29.000000Z'
                  updated_at: '2026-03-10T17:45:02.000000Z'
                  deleted_at: null
                links:
                  first: https://api.thanks.io/api/v2/webhooks?page=1
                  last: https://api.thanks.io/api/v2/webhooks?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  path: https://api.thanks.io/api/v2/webhooks
                  per_page: '15'
                  to: 2
                  total: 2
                can_manage_webhooks: true
        '403':
          $ref: '#/components/responses/Unauthorized'
      operationId: getWebhooks
      x-operation-id-source: derived
    post:
      tags:
      - Webhooks
      operationId: createWebhook
      summary: Create Webhook
      description: Create a webhook destination. Webhooks are available on paid subscriptions only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  example: https://example.com/webhooks/thanksio
                type:
                  $ref: '#/components/schemas/webhook-type'
                scan_board_status:
                  type:
                  - string
                  - 'null'
                  enum:
                  - new
                  - contacted
                  - follow_up
                  - done
                  - null
                  description: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
                  example: null
                description:
                  type:
                  - string
                  - 'null'
                  example: Order status updates
                verb:
                  type: string
                  example: post
                mailing_list_id:
                  type:
                  - integer
                  - 'null'
                  example: null
              required:
              - url
              - type
              - verb
            example:
              url: https://example.com/webhooks/thanksio
              type: order.status_update
              description: Order status updates
              verb: post
              mailing_list_id: null
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    $ref: '#/components/schemas/webhook-type'
                  scan_board_status:
                    type:
                    - string
                    - 'null'
                    enum:
                    - new
                    - contacted
                    - follow_up
                    - done
                    - null
                    description: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
                    example: null
                  url:
                    type: string
                    format: uri
                    example: https://example.com/webhooks/thanksio
                  description:
                    type:
                    - string
                    - 'null'
                    example: Order status updates
                  verb:
                    type: string
                    example: post
                  mailing_list_id:
                    type:
                    - integer
                    - 'null'
                    example: null
                  user_id:
                    type: integer
                    example: 2
                  invoke_count:
                    type: integer
                    example: 0
                  updated_at:
                    type: string
                    format: date-time
                    example: '2026-03-10T18:59:24.000000Z'
                  created_at:
                    type: string
                    format: date-time
                    example: '2026-03-10T18:59:24.000000Z'
                  id:
                    type: integer
                    example: 13
              example:
                type: order.status_update
                url: https://example.com/webhooks/thanksio
                description: Order status updates
                verb: post
                mailing_list_id: null
                user_id: 2
                invoke_count: 0
                updated_at: '2026-03-10T18:59:24.000000Z'
                created_at: '2026-03-10T18:59:24.000000Z'
                id: 13
        '403':
          $ref: '#/components/responses/Unauthorized'
  /webhooks/{webhookId}:
    parameters:
    - name: webhookId
      in: path
      description: ID of webhook
      required: true
      schema:
        type: integer
        example: 11
    put:
      tags:
      - Webhooks
      operationId: updateWebhook
      summary: Update Webhook
      description: Update an existing webhook destination. Webhooks are available on paid subscriptions only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  example: https://example.com/webhooks/thanksio-updated
                description:
                  type:
                  - string
                  - 'null'
                  example: Updated webhook destination
                verb:
                  type: string
                  example: get
                type:
                  $ref: '#/components/schemas/webhook-type'
                scan_board_status:
                  type:
                  - string
                  - 'null'
                  enum:
                  - new
                  - contacted
                  - follow_up
                  - done
                  - null
                  description: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
                  example: null
              required:
              - url
              - type
              - verb
            example:
              url: https://example.com/webhooks/thanksio-updated
              description: Updated webhook destination
              verb: get
              type: order_item.status_update
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 13
                  user_id:
                    type: integer
                    example: 2
                  mailing_list_id:
                    type:
                    - integer
                    - 'null'
                    example: null
                  type:
                    $ref: '#/components/schemas/webhook-type'
                  scan_board_status:
                    type:
                    - string
                    - 'null'
                    enum:
                    - new
                    - contacted
                    - follow_up
                    - done
                    - null
                    description: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
                    example: null
                  description:
                    type:
                    - string
                    - 'null'
                    example: Updated webhook destination
                  invoke_count:
                    type: integer
                    example: 0
                  url:
                    type: string
                    format: uri
                    example: https://example.com/webhooks/thanksio-updated
                  verb:
                    type: string
                    example: get
                  created_at:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    example: '2026-03-10T18:59:24.000000Z'
                  updated_at:
                    type: string
                    format: date-time
                    example: '2026-03-10T20:54:01.000000Z'
                  deleted_at:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    example: null
              example:
                id: 13
                user_id: 2
                mailing_list_id: null
                type: order_item.status_update
                description: Updated webhook destination
                invoke_count: 0
                url: https://example.com/webhooks/thanksio-updated
                verb: get
                created_at: '2026-03-10T18:59:24.000000Z'
                updated_at: '2026-03-10T20:54:01.000000Z'
                deleted_at: null
        '403':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Webhooks
      operationId: deleteWebhook
      summary: Delete Webhook
      description: Delete a webhook destination. Webhooks are available on paid subscriptions only.
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
              example:
                status: success
        '403':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Not Found
    Unauthorized:
      description: Access token is missing or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthorized
  schemas:
    scan-board-status:
      type: string
      description: A QR Scan Board stage.
      enum:
      - new
      - contacted
      - follow_up
      - done
      example: contacted
    meta:
      type: object
      properties:
        current_page:
          type: integer
          example: 1
          description: Current page number
        from:
          type:
          - integer
          - 'null'
          example: 1
          description: Index of the first item on the current page
        last_page:
          type: integer
          example: 1
          description: Total number of pages
        path:
          type: string
          description: Base URL for the resource
        per_page:
          type: integer
          example: 25
          description: Number of items per page
        to:
          type:
          - integer
          - 'null'
          example: 1
          description: Index of the last item on the current page
        total:
          type: integer
          example: 1
          description: Total number of items
    webhook-type:
      type: string
      enum:
      - order_item.status_update
      - order.status_update
      - order_item.delivered
      - scans.scan_update
      - scan_board.status_update
      example: order_item.status_update
    links:
      type: object
      properties:
        first:
          type:
          - string
          - 'null'
          description: URL of the first page of results
        last:
          type:
          - string
          - 'null'
          description: URL of the last page of results
        prev:
          type:
          - string
          - 'null'
          description: URL of the previous page of results
        next:
          type:
          - string
          - 'null'
          description: URL of the next page of results
  parameters:
    items_per_page:
      name: items_per_page
      in: query
      description: Number of items to return per page.
      required: false
      schema:
        type: integer
        default: 25
      example: 5
  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