> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# Get webhook event schema

> Get webhook event schema: getWebhookEventSchema in the TypeScript, Python and Rust clients.

`GET /v1/projects/{projectId}/webhooks/event-types/{eventType}/schema`

Returns the published reader JSON Schema for eventType in the requested webhook apiVersion. Use it to interpret events for that exact payload version. The response media type is application/schema+json; an authorized conditional request may return 304 without a body. Unsupported event/version combinations are rejected.

<Tabs>
  <Tab title="TypeScript">
    ```typescript TypeScript theme={null}
    photon.projects.getWebhookEventSchema(input: GetWebhookEventSchemaInput, options?: RequestOptions): Promise<GetWebhookEventSchemaOutput>
    ```
  </Tab>

  <Tab title="Python">
    ```python Python theme={null}
    photon.projects.get_webhook_event_schema(input: GetWebhookEventSchemaInput) -> models.WebhookEventSchema | None
    ```
  </Tab>

  <Tab title="Rust">
    ```rust Rust theme={null}
    client.get_webhook_event_schema(project_id: String, event_type: String, api_version: Date).await -> Result<ResponseValue<GetWebhookEventSchemaResponse>, Error<GetWebhookEventSchemaError>>
    ```
  </Tab>
</Tabs>

<RequestExample>
  ```typescript TypeScript theme={null}
  import { Photon } from "@photon-ai/api";

  const photon = new Photon({
    headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
  });
  const result = await photon.projects.getWebhookEventSchema({
    path: {
      projectId: "projectId",
      eventType: "eventType",
    },
    query: {
      apiVersion: "2026-01-01",
    },
  });
  ```

  ```python Python theme={null}
  import os

  from photon_api import Photon
  from photon_api.rpc_generated import GetWebhookEventSchemaInput

  photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
  result = photon.projects.get_webhook_event_schema(
      GetWebhookEventSchemaInput.model_validate({
          "path": {
              "projectId": "projectId",
              "eventType": "eventType",
          },
          "query": {
              "apiVersion": "2026-01-01",
          },
      })
  )
  ```

  ```rust Rust theme={null}
  use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

  let token = std::env::var("PHOTON_API_TOKEN")?;
  let client = PhotonClientBuilder::new()
      .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
      .build()?;
  let result = client
      .get_webhook_event_schema(
          "projectId".to_owned(),
          "eventType".to_owned(),
          serde_json::from_value(serde_json::json!("2026-01-01"))?,
      )
      .await
      .map_err(|error| format!("{error:?}"))?
      .into_inner();
  ```
</RequestExample>

## Parameters

<ParamField path="projectId" type={"string"} required />

<ParamField path="eventType" type={"string"} required />

<ParamField query="apiVersion" type={"string (date)"} required />

## Returns

**`200`** The published reader JSON Schema for the event. The `application/schema+json` body.

**`304`** The authorized cached representation is current; no response body. No body.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.