---
updatedAt: 2026-05-01T04:08:52.000Z
agentTools:
  projectIndex: https://docs.oneschema.co/llms.txt
---

# Create an event webhook

Creates an event webhook for a supported product area.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Event Webhooks",
    "version": "0.0.1",
    "contact": {
      "name": "OneSchema Support",
      "email": "support@oneschema.co"
    },
    "license": {
      "name": "proprietary",
      "url": "https://www.oneschema.co/terms-and-conditions"
    },
    "termsOfService": "https://www.oneschema.co/terms-and-conditions",
    "description": "An API for managing event webhooks that receive product lifecycle notifications. This API currently supports Importer and Multi FileFeed event webhooks."
  },
  "tags": [
    {
      "name": "Event Webhooks",
      "description": "Event webhook operations"
    }
  ],
  "paths": {
    "/v1/event-webhooks": {
      "post": {
        "operationId": "create-event-webhook",
        "summary": "Create an event webhook",
        "description": "Creates an event webhook for a supported product area.",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/event-webhook-resource"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-response"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized (missing or invalid API key)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-response"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-response"
                }
              }
            }
          }
        },
        "tags": [
          "Event Webhooks"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/event-webhook-create-importer-request"
                  },
                  {
                    "$ref": "#/components/schemas/event-webhook-create-multi-file-feeds-request"
                  }
                ]
              }
            }
          }
        },
        "x-readme": {
          "hidden": true
        }
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "components": {
    "schemas": {
      "error-response": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "A machine-readable error code."
          },
          "param": {
            "type": "string",
            "description": "The parameter that caused the error."
          },
          "message": {
            "type": "string",
            "description": "A human-readable error message."
          },
          "data": {
            "type": "object",
            "description": "Additional error context."
          }
        }
      },
      "event-webhook-create-importer-request": {
        "type": "object",
        "required": [
          "webhook_key",
          "product_area",
          "url"
        ],
        "properties": {
          "webhook_key": {
            "type": "string",
            "description": "A unique (per-org) key identifying this event webhook."
          },
          "product_area": {
            "type": "string",
            "enum": [
              "importer"
            ],
            "description": "Product area that owns the event webhook."
          },
          "url": {
            "type": "string",
            "description": "The HTTPS URL that OneSchema will POST event payloads to."
          },
          "description": {
            "type": "string",
            "description": "Optional human-readable description. Defaults to an empty string.",
            "nullable": true
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event-webhook-importer-event-type"
            },
            "description": "Importer event types to subscribe to. Defaults to an empty array."
          },
          "secret_key": {
            "type": "string",
            "description": "Optional shared secret sent using HTTP Basic authentication.",
            "nullable": true
          }
        }
      },
      "event-webhook-create-multi-file-feeds-request": {
        "type": "object",
        "required": [
          "webhook_key",
          "product_area",
          "url"
        ],
        "properties": {
          "webhook_key": {
            "type": "string",
            "description": "A unique (per-org) key identifying this event webhook."
          },
          "product_area": {
            "type": "string",
            "enum": [
              "multi_file_feeds"
            ],
            "description": "Product area that owns the event webhook."
          },
          "url": {
            "type": "string",
            "description": "The HTTPS URL that OneSchema will POST event payloads to."
          },
          "description": {
            "type": "string",
            "description": "Optional human-readable description. Defaults to an empty string.",
            "nullable": true
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event-webhook-multi-file-feed-event-type"
            },
            "description": "Multi FileFeed event types to subscribe to. Defaults to an empty array."
          },
          "secret_key": {
            "type": "string",
            "description": "Optional shared secret sent using HTTP Basic authentication.",
            "nullable": true
          }
        }
      },
      "event-webhook-event-type": {
        "type": "string",
        "enum": [
          "embed_initialized",
          "embed_resumed",
          "embed_closed",
          "file_uploaded",
          "header_selected",
          "columns_mapped",
          "sheet_operation_performed",
          "import_submitted",
          "initial_validation_complete",
          "initial_validation_failed",
          "import_complete",
          "import_failed",
          "multi_file_feed_import_success",
          "multi_file_feed_import_error",
          "multi_file_feed_s3_read_success",
          "multi_file_feed_s3_read_error",
          "multi_file_feed_s3_write_success",
          "multi_file_feed_s3_write_error"
        ],
        "description": "Event type delivered to the webhook URL."
      },
      "event-webhook-importer-event-type": {
        "type": "string",
        "enum": [
          "embed_initialized",
          "embed_resumed",
          "embed_closed",
          "file_uploaded",
          "header_selected",
          "columns_mapped",
          "sheet_operation_performed",
          "import_submitted",
          "initial_validation_complete",
          "initial_validation_failed",
          "import_complete",
          "import_failed"
        ],
        "description": "Importer event type delivered to the webhook URL."
      },
      "event-webhook-multi-file-feed-event-type": {
        "type": "string",
        "enum": [
          "multi_file_feed_import_success",
          "multi_file_feed_import_error",
          "multi_file_feed_s3_read_success",
          "multi_file_feed_s3_read_error",
          "multi_file_feed_s3_write_success",
          "multi_file_feed_s3_write_error"
        ],
        "description": "Multi FileFeed event type delivered to the webhook URL."
      },
      "event-webhook-product-area": {
        "type": "string",
        "enum": [
          "importer",
          "multi_file_feeds"
        ],
        "description": "Product area that owns the event webhook."
      },
      "event-webhook-resource": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the event webhook."
          },
          "webhook_key": {
            "type": "string",
            "description": "The org-unique key identifying this event webhook."
          },
          "product_area": {
            "$ref": "#/components/schemas/event-webhook-product-area"
          },
          "url": {
            "type": "string",
            "description": "The HTTPS URL that OneSchema will POST event payloads to."
          },
          "description": {
            "type": "string",
            "description": "Optional human-readable description."
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event-webhook-event-type"
            },
            "description": "Event types subscribed to by this webhook."
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oneschema.co",
      "description": "Production server (hosted in the US)",
      "variables": {}
    },
    {
      "url": "https://api.eu.oneschema.co",
      "description": "Production server (hosted in the EU)",
      "variables": {}
    },
    {
      "url": "https://api.ca.oneschema.co",
      "description": "Production server (hosted in Canada)",
      "variables": {}
    },
    {
      "url": "https://api.au.oneschema.co",
      "description": "Production server (hosted in Australia)",
      "variables": {}
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```