Pinwheel · Schema

Webhook

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
url	string	The URL of the webhook endpoints.
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.
id	string	Unique identifier for the object.
created_at	string	ISO 8601 timestamp of created time.
last_updated	string	ISO 8601 timestamp of the last update to this object.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "url": {
      "type": "string",
      "title": "url",
      "description": "The URL of the webhook endpoints."
    },
    "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."
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "id",
      "description": "Unique identifier for the object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "created_at",
      "description": "ISO 8601 timestamp of created time."
    },
    "last_updated": {
      "type": "string",
      "format": "date-time",
      "title": "last_updated",
      "description": "ISO 8601 timestamp of the last update to this object."
    }
  },
  "type": "object",
  "required": [
    "url",
    "status",
    "enabled_events",
    "version",
    "id",
    "created_at",
    "last_updated"
  ],
  "title": "Webhook",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/WebhookObjResponse.json"
}