---
title: "Get event definition by key"
method: GET
path: "/event-registry/event-definitions/key/{key}/model"
tags: ["Inspect", "Event Registry"]
---

# Get event definition by key

`GET /event-registry/event-definitions/key/{key}/model`

## Request

- Base URL: `http://localhost:8090/inspect-api`
- URL: `http://localhost:8090/inspect-api/event-registry/event-definitions/key/{key}/model`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/docs/event-registry/event-definitions/key/:key/model/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `key` string, required

## Response `200`

Indicates the definition was found and returned.

- EventModel
  - `key` string
  - `name` string
  - `payload` EventPayload[]
    - `name` string
    - `type` string
    - `header` boolean
    - `correlationParameter` boolean
    - `metaParameter` boolean
    - `extensionProperties` object
    - `fullPayload` boolean

---

[API](https://skmtc.dev/flowable/apis/flowable-inspect-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/revisions/5c72eb80b6c5?raw)