postzen-dev · Schema

WebhookUpdateRequest

Include at least one field. Omitted fields keep their stored values.

Social MediaDeveloper ToolsAI AgentsAutomation

Properties

Name Type Description
name string
url string
events array
profileAccess string
profileIds array Replacement profile selection. Must be non-empty for selected_profiles and empty for all_profiles.
secret stringnull Omit to keep the stored secret, send a non-empty string to replace it, or send null to remove it.
customHeaders array Omit to keep stored headers. Send the complete collection to replace all headers, or [] to remove all headers. Every supplied value is plaintext and is encrypted at rest.
isActive boolean Enable or disable delivery. Re-enabling resets the consecutive exhausted-event count.
View JSON Schema on GitHub

JSON Schema

postzen-dev-webhook-update-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-webhook-update-request-schema.json",
  "title": "WebhookUpdateRequest",
  "description": "Include at least one field. Omitted fields keep their stored values.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postzen-dev-webhooks-api-openapi.yml#/components/schemas/WebhookUpdateRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/WebhookEvent"
      }
    },
    "profileAccess": {
      "type": "string",
      "enum": [
        "all_profiles",
        "selected_profiles"
      ]
    },
    "profileIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Replacement profile selection. Must be non-empty for selected_profiles and empty for all_profiles."
    },
    "secret": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 256,
      "writeOnly": true,
      "description": "Omit to keep the stored secret, send a non-empty string to replace it, or send null to remove it."
    },
    "customHeaders": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "$ref": "#/$defs/WebhookCustomHeader"
      },
      "description": "Omit to keep stored headers. Send the complete collection to replace all headers, or [] to remove all headers. Every supplied value is plaintext and is encrypted at rest."
    },
    "isActive": {
      "type": "boolean",
      "description": "Enable or disable delivery. Re-enabling resets the consecutive exhausted-event count."
    }
  },
  "$defs": {
    "WebhookCustomHeader": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "HTTP header name. Content-Type, transport headers, and X-PostZen-* names are reserved."
        },
        "value": {
          "type": "string",
          "maxLength": 4096,
          "writeOnly": true,
          "description": "Plaintext header value. PostZen encrypts it at rest and never returns it."
        }
      }
    },
    "WebhookEvent": {
      "type": "string",
      "enum": [
        "post.scheduled",
        "post.published",
        "post.partially_failed",
        "post.failed",
        "post.cancelled",
        "post.platform.published",
        "post.platform.failed",
        "post.external.created",
        "account.connected",
        "account.needs_reauth",
        "account.disconnected",
        "analytics.synced",
        "conversation.started",
        "message.received",
        "message.sent",
        "comment.received",
        "contact.tag_added",
        "contact.tag_removed",
        "contact.field_changed",
        "webhook.test"
      ],
      "description": "Webhook event type. See the Webhook Events section for each event's trigger and payload. Receivers should tolerate additional event types in future API versions."
    }
  }
}

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/postzen-dev-webhook-update-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.