WebhookRequestBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/assembly-payments/main/json-schema/assembly-payments-webhook-request-body-schema.json",
  "title": "WebhookRequestBody",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/assembly-payments-webhooks-api-openapi.yml#/components/schemas/WebhookRequestBody",
  "type": "object",
  "required": [
    "url",
    "enabled",
    "object_type"
  ],
  "properties": {
    "url": {
      "description": "URL to which the webhook will notify",
      "type": "string",
      "default": "https://httpbin.org"
    },
    "object_type": {
      "description": "Object or entity to which the webhook refer. Please refer to [Webhook](https://developer.assemblypayments.com/docs/callbacks) for a list of object types.",
      "type": "string",
      "enum": [
        "batch_transactions",
        "accounts",
        "addresses",
        "companies",
        "items",
        "disbursements",
        "users",
        "transactions",
        "virtual_accounts",
        "pay_ids",
        "verifications",
        "payto_agreements"
      ]
    },
    "description": {
      "description": "Description to identify the webhook",
      "type": "string",
      "default": "Batch Transactions Webhook"
    }
  }
}