# /forms/{formId}/webhooks/openapi

Get OpenAPI definition for a form's webhook

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Formstack API v2025.0",
    "version": "0.0.4"
  },
  "servers": [
    {
      "url": "https://www.formstack.com/api/v2025",
      "description": "Production server"
    },
    {
      "url": "https://staging-formstack.com/api/v2025",
      "description": "Staging server"
    },
    {
      "url": "https://dev-formstack.com/api/v2025",
      "description": "Development server"
    }
  ],
  "paths": {
    "/forms/{formId}/webhooks/openapi": {
      "get": {
        "tags": [
          "Webhook"
        ],
        "description": "Get OpenAPI definition for a form's webhook",
        "operationId": "getWebhookOpenApi",
        "parameters": [
          {
            "name": "formId",
            "in": "path",
            "description": "The ID of the form",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OpenAPI definition",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookOpenApiDefinitionDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Form not found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "WebhookOpenApiDefinitionDto": {
        "title": "Webhook OpenAPI Definition",
        "description": "OpenAPI definition for a form's webhook payload structure",
        "properties": {
          "type": {
            "description": "Schema type (always 'object')",
            "type": "string",
            "example": "object"
          },
          "properties": {
            "description": "Schema properties defining webhook payload structure",
            "type": "object",
            "example": {
              "FormID": {
                "type": "string"
              },
              "UniqueID": {
                "type": "string"
              },
              "Name": {
                "type": "string"
              },
              "Email": {
                "type": "string"
              },
              "Message": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "type": "object"
      }
    }
  },
  "tags": [
    {
      "name": "Webhook",
      "description": "Webhooks push submission data to an external URL in real time as forms are submitted. Use these endpoints to list a form's webhooks and to create, retrieve, update, and delete them, configure payload format, HMAC signing, and failure notifications, and fetch the generated OpenAPI definition describing a webhook's payload."
    }
  ]
}
```