---
title: "Start an event consumer."
method: PUT
path: "/api/event-consumers/{consumerName}/start"
tags: ["EventConsumers"]
---

# Start an event consumer.

`PUT /api/event-consumers/{consumerName}/start`

## Path parameters

- `consumerName` string, required

## Response `200`

Event consumer started asynchronously.

- EventConsumerDto
  - `_links` object, required — The links.
  - `isStopped` boolean, required — Indicates if the event consumer has been started.
  - `isResetting` boolean, required — Indicates if the event consumer is resetting at the moment.
  - `count` integer, required — The number of handled events.
  - `name` string, required — The name of the event consumer.
  - `error` string, nullable — The error details if the event consumer has been stopped after a failure.
  - `position` string, nullable — The position within the vent stream.

## Other responses

- `400` — Validation error.
- `404` — Event consumer not found.
- `500` — Operation failed.

---

[API](https://skmtc.net/squidex/apis/squidex-api.md) · [All operations](https://skmtc.net/squidex/apis/squidex-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/squidex/squidex-api/revisions/b4a9b62f113a/schema)