WebhookCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argyle9a25/json-schema/argyle9a25-webhook-create-request-schema.json",
  "title": "WebhookCreateRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argyle9a25-webhook-management-api-openapi.yml#/components/schemas/WebhookCreateRequest",
  "type": "object",
  "properties": {
    "events": {
      "type": "array",
      "description": "Webhook events to include in the webhook subscription.",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string",
      "description": "Your name for the webhook subscription."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form."
    },
    "secret": {
      "type": "string",
      "description": "Optional secret used to [verify webhooks](/api-guide/webhooks#verifying-webhooks)."
    },
    "config": {
      "type": "object",
      "description": "Optional event-specific configuration for the webhook subscription. (*Only applicable to certain webhooks*)",
      "additionalProperties": true
    }
  },
  "required": [
    "events",
    "name",
    "url"
  ]
}