---
title: "Trigger event registry event"
method: POST
path: "/event-registry-events/{id}"
tags: ["Inspect"]
---

# Trigger event registry event

`POST /event-registry-events/{id}`

## Request

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

## Path parameters

- `eventId` string, required

## Request body

- SendEventRequest: Request that is used for sending an event to a channel
  - `createTestDefinition` boolean: Whether a test definition needs to be created for the request. Only used when triggering for a definition
  - `channelDefinitionKey` string: The optional key for the channel definition on which the event needs to be sent to
  - `eventDefinitionKey` string: The optional event key that should be used for the event.
  - `eventDefinitionPayload` EventPayload[]: The payload for the event definition key.
    - `name` string
    - `type` string
    - `header` boolean
    - `correlationParameter` boolean
    - `metaParameter` boolean
    - `extensionProperties` object
    - `fullPayload` boolean
  - `customPayload` string: The custom payload that needs to be send on the channel.

## Response `200`

Indicates the event registry event is found and triggered.

- TriggerResultDTO
  - `instanceId` string
  - `instanceType` string

## Other responses

- `404`: Indicates the event registry event was not found.

---

[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)
