Fieldwire Subscriptions API

Webhook subscription lifecycle.

Operations 5

GET /subscriptions Get Subscriptions #
POST /subscriptions Create Subscription #
GET /subscriptions/{subscription_id} Get Subscription By ID #
PATCH /subscriptions/{subscription_id} Update Subscription By ID #
DELETE /subscriptions/{subscription_id} Delete Subscription By ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/fieldwire-subscriptions-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.

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

OpenAPI Specification

fieldwire-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fieldwire Webhooks Subscriptions API
  description: 'Configure webhook subscriptions to receive real-time event notifications

    for attachments, entity tags / taggings, floorplans, forms, hyperlinks,

    multi-hyperlinks, projects, project resource links, sheets, sheet uploads,

    tasks, task check items, and task relations. Per-subscription

    `entity_filters` (max 20 entries) and `project_filters` (max 100 entries)

    narrow event delivery.

    '
  version: v3.1
  contact:
    name: Fieldwire Developer Support
    url: https://developers.fieldwire.com/
  license:
    name: Fieldwire Terms of Service
    url: https://www.fieldwire.com/terms/
servers:
- url: https://client-api.us.fieldwire.com/api/v3
  description: US Region
- url: https://client-api.eu.fieldwire.com/api/v3
  description: EU Region
security:
- BearerAuth: []
tags:
- name: Subscriptions
  description: Webhook subscription lifecycle.
paths:
  /subscriptions:
    get:
      operationId: getSubscriptions
      summary: Get Subscriptions
      tags:
      - Subscriptions
      responses:
        '200':
          description: Subscription list.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Subscription'
    post:
      operationId: createSubscription
      summary: Create Subscription
      description: 'Create a webhook subscription. Required fields: `subscription_name`

        (max 50 chars), `description` (max 200 chars), `post_url`, and

        `subscription_status`. Optional filters: `entity_filters` (max 20),

        `project_filters` (max 100).

        '
      tags:
      - Subscriptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionCreate'
      responses:
        '201':
          description: Created subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
  /subscriptions/{subscription_id}:
    get:
      operationId: getSubscriptionById
      summary: Get Subscription By ID
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: Subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
    patch:
      operationId: updateSubscriptionById
      summary: Update Subscription By ID
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionUpdate'
      responses:
        '200':
          description: Updated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
    delete:
      operationId: deleteSubscriptionById
      summary: Delete Subscription By ID
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '204':
          description: Subscription deleted.
components:
  parameters:
    SubscriptionId:
      name: subscription_id
      in: path
      required: true
      schema:
        type: integer
        format: int64
  schemas:
    Subscription:
      type: object
      properties:
        subscription_id:
          type: integer
          format: int64
        subscription_name:
          type: string
          maxLength: 50
        description:
          type: string
          maxLength: 200
        post_url:
          type: string
          format: uri
        subscription_status:
          type: string
          enum:
          - enabled
          - disabled
        account_id:
          type: integer
          format: int64
        internal:
          type: boolean
        entity_filters:
          type: array
          maxItems: 20
          items:
            type: string
            description: 'Entity name to filter on, e.g. `task`, `attachment`, `floorplan`,

              `form`, `project`, `sheet`, `hyperlink`, `multi_hyperlink`,

              `entity_tag`, `entity_tagging`, `project_resource_link`,

              `task_check_item`, `task_relation`, `sheet_upload`.

              '
        project_filters:
          type: array
          maxItems: 100
          items:
            type: integer
            format: int64
    SubscriptionUpdate:
      type: object
      properties:
        subscription_name:
          type: string
          maxLength: 50
        description:
          type: string
          maxLength: 200
        post_url:
          type: string
          format: uri
        subscription_status:
          type: string
          enum:
          - enabled
          - disabled
        entity_filters:
          type: array
          maxItems: 20
          items:
            type: string
        project_filters:
          type: array
          maxItems: 100
          items:
            type: integer
            format: int64
    SubscriptionCreate:
      type: object
      required:
      - subscription_name
      - description
      - post_url
      - subscription_status
      properties:
        subscription_name:
          type: string
          maxLength: 50
        description:
          type: string
          maxLength: 200
        post_url:
          type: string
          format: uri
        subscription_status:
          type: string
          enum:
          - enabled
          - disabled
        entity_filters:
          type: array
          maxItems: 20
          items:
            type: string
        project_filters:
          type: array
          maxItems: 100
          items:
            type: integer
            format: int64
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT