Webhook

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-webhook-schema.json",
  "title": "Webhook",
  "description": "A webhook is used to POST new/updated information to your server.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "workspace_id": {
      "type": "string"
    },
    "connection_id": {
      "type": "string"
    },
    "hook_url": {
      "type": "string"
    },
    "object_type": {
      "type": "string",
      "enum": [
        "accounting_account",
        "accounting_transaction",
        "accounting_journal",
        "accounting_contact",
        "accounting_invoice",
        "accounting_bill",
        "accounting_creditmemo",
        "accounting_taxrate",
        "accounting_organization",
        "accounting_order",
        "accounting_salesorder",
        "accounting_purchaseorder",
        "accounting_report",
        "accounting_balancesheet",
        "accounting_profitloss",
        "accounting_trialbalance",
        "accounting_category",
        "accounting_expense",
        "accounting_cashflow",
        "payment_payment",
        "payment_link",
        "payment_payout",
        "payment_refund",
        "payment_subscription",
        "commerce_item",
        "commerce_collection",
        "commerce_inventory",
        "commerce_location",
        "commerce_review",
        "commerce_saleschannel",
        "commerce_itemvariant",
        "commerce_reservation",
        "commerce_availability",
        "verification_package",
        "verification_request",
        "assessment_package",
        "assessment_order",
        "ats_activity",
        "ats_application",
        "ats_applicationstatus",
        "ats_candidate",
        "ats_document",
        "ats_interview",
        "ats_job",
        "ats_scorecard",
        "ats_company",
        "crm_company",
        "crm_contact",
        "crm_deal",
        "crm_event",
        "crm_lead",
        "crm_pipeline",
        "hris_employee",
        "hris_group",
        "hris_payslip",
        "hris_timeoff",
        "hris_company",
        "hris_location",
        "hris_device",
        "hris_timeshift",
        "hris_deduction",
        "hris_benefit",
        "hris_bankaccount",
        "martech_list",
        "martech_member",
        "martech_campaign",
        "martech_report",
        "passthrough",
        "ticketing_note",
        "ticketing_ticket",
        "ticketing_customer",
        "ticketing_category",
        "uc_contact",
        "uc_call",
        "uc_comment",
        "uc_recording",
        "enrich_person",
        "enrich_company",
        "storage_file",
        "genai_model",
        "genai_prompt",
        "genai_embedding",
        "messaging_message",
        "messaging_channel",
        "messaging_event",
        "kms_space",
        "kms_page",
        "kms_comment",
        "task_project",
        "task_task",
        "task_comment",
        "task_change",
        "scim_users",
        "scim_groups",
        "lms_course",
        "lms_class",
        "lms_student",
        "lms_instructor",
        "lms_content",
        "lms_collection",
        "lms_activity",
        "repo_organization",
        "repo_repository",
        "repo_branch",
        "repo_commit",
        "repo_pullrequest",
        "metadata_metadata",
        "calendar_calendar",
        "calendar_event",
        "calendar_busy",
        "calendar_link",
        "calendar_recording",
        "calendar_webinar",
        "ads_organization",
        "ads_ad",
        "ads_campaign",
        "ads_report",
        "ads_group",
        "ads_creative",
        "ads_insertionorder",
        "ads_target",
        "ads_promoted",
        "forms_form",
        "forms_submission",
        "shipping_carrier",
        "shipping_rate",
        "shipping_shipment",
        "shipping_label",
        "shipping_tracking",
        "signing_document",
        "signing_signatory",
        "signing_template"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "interval": {
      "type": "number"
    },
    "checked_at": {
      "type": "string",
      "format": "date-time"
    },
    "integration_type": {
      "type": "string"
    },
    "environment": {
      "type": "string",
      "default": "Production"
    },
    "event": {
      "type": "string",
      "enum": [
        "updated",
        "created",
        "deleted"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "runs": {
      "$ref": "#/components/schemas/property_Webhook_runs"
    },
    "fields": {
      "type": "string"
    },
    "webhook_type": {
      "type": "string",
      "enum": [
        "virtual",
        "native"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "is_healthy": {
      "type": "boolean"
    },
    "page_max_limit": {
      "type": "number"
    },
    "filters": {
      "$ref": "#/components/schemas/property_Webhook_filters"
    },
    "db_type": {
      "type": "string",
      "enum": [
        "mongodb",
        "mysql",
        "postgres",
        "mssql",
        "mariadb",
        "supabase"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "db_url": {
      "type": "string"
    },
    "db_schema": {
      "type": "string"
    },
    "db_name_prefix": {
      "type": "string"
    },
    "is_paused": {
      "type": "boolean"
    },
    "is_beta": {
      "type": "boolean"
    }
  },
  "required": [
    "connection_id",
    "object_type",
    "event"
  ]
}