Pinwheel · Schema

WebhookPostBody

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
url	string	The URL of the webhook endpoints. Must be 'https://'.
status	object	The status of the webhook.
enabled_events	array	The list of events enabled for this webhook.
version	object	The webhook's version, which determines the format of the webhook event payloads.
customer_id	string	Banking platforms webhooks only: the customer ID associated with the platform's customer.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "url": {
      "type": "string",
      "title": "url",
      "description": "The URL of the webhook endpoints. Must be 'https://'."
    },
    "status": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "active",
            "paused"
          ]
        }
      ],
      "description": "The status of the webhook."
    },
    "enabled_events": {
      "items": {
        "type": "string",
        "enum": [
          "paystubs.thirty_days_synced",
          "paystubs.ninety_days_synced",
          "direct_deposit_switch.added",
          "verification_reports.refreshed",
          "paystubs.documents.added",
          "paystubs.added",
          "company_connect.employments.added",
          "shifts.added",
          "bill.added",
          "shifts.thirty_days_synced",
          "account.monitoring_status.updated",
          "paystubs.seven_days_synced",
          "earnings_stream.payouts.refreshed",
          "bill.updated",
          "company_connect.status.updated",
          "income.added",
          "shifts.seven_days_synced",
          "paystubs.fully_synced",
          "identity.added",
          "employment.added",
          "shifts.fully_synced",
          "company_connect.incomes.added",
          "account.additional_connections_recommended",
          "bill_switch.added",
          "account.added",
          "company_connect.census.added",
          "paycheck_viewer.added",
          "direct_deposit_allocations.added",
          "bill_switch.cancelled",
          "bill.reminder",
          "tax_forms.added",
          "documents.added",
          "bill.removed",
          "shifts.ninety_days_synced"
        ]
      },
      "type": "array",
      "minItems": 1,
      "description": "The list of events enabled for this webhook."
    },
    "version": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "2022-09-09",
            "2025-07-08",
            "2023-04-18",
            "2023-11-22",
            "2023-07-18"
          ]
        }
      ],
      "description": "The webhook's version, which determines the format of the webhook event payloads."
    },
    "customer_id": {
      "type": "string",
      "title": "customer_id",
      "description": "Banking platforms webhooks only: the customer ID associated with the platform's customer."
    }
  },
  "type": "object",
  "required": [
    "url",
    "status",
    "enabled_events",
    "version"
  ],
  "title": "WebhookPostBody",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/WebhookCreate_v2023_04_18.json"
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
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 JSON Schema

curl "https://apis.io/api/v1/json-schemas/webhookcreate-v2023-04-18"

All schemas

curl "https://apis.io/api/v1/json-schemas?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.