WorkOS · Schema

WebhookEndpointJson

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string	Distinguishes the Webhook Endpoint object.
id	string	Unique identifier of the Webhook Endpoint.
endpoint_url	string	The URL to which webhooks are sent.
secret	string	The secret used to sign webhook payloads.
status	string	Whether the Webhook Endpoint is enabled or disabled.
events	array	The events that the Webhook Endpoint is subscribed to.
created_at	string	An ISO 8601 timestamp.
updated_at	string	An ISO 8601 timestamp.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookEndpointJson",
  "title": "WebhookEndpointJson",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the Webhook Endpoint object.",
      "const": "webhook_endpoint"
    },
    "id": {
      "type": "string",
      "description": "Unique identifier of the Webhook Endpoint.",
      "example": "we_0123456789"
    },
    "endpoint_url": {
      "type": "string",
      "description": "The URL to which webhooks are sent.",
      "example": "https://example.com/webhooks"
    },
    "secret": {
      "type": "string",
      "description": "The secret used to sign webhook payloads.",
      "example": "whsec_0FWAiVGkEfGBqqsJH4aNAGBJ4"
    },
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ],
      "description": "Whether the Webhook Endpoint is enabled or disabled.",
      "example": "enabled"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The events that the Webhook Endpoint is subscribed to.",
      "example": [
        "user.created",
        "dsync.user.created"
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "object",
    "id",
    "endpoint_url",
    "secret",
    "status",
    "events",
    "created_at",
    "updated_at"
  ]
}