---
title: "Create a broadcast event"
method: POST
path: "/v1/projects/{projectID}/events/broadcast"
tags: ["Events"]
---

# Create a broadcast event

`POST /v1/projects/{projectID}/events/broadcast`

This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.
The 201 body includes uid (the event id). Use GET /events/{eventID} or GET /eventdeliveries?eventId= to follow the send.

## Path parameters

- `projectID` string, required

## Request body

- ModelsBroadcastEvent
  - `acknowledged_at` string
  - `custom_headers` object, nullable — Specifies custom headers you want convoy to add when the event is dispatched to your endpoint
  - `data` object, nullable — Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints
  - `event_type` string — Event Type is used for filtering and debugging e.g invoice.paid
  - `idempotency_key` string — Specify a key for event deduplication

## Response `201`

Created

- object
  - `message` string
  - `status` boolean
  - `data` ModelsEventQueuedResponse
    - `event_type` string
    - `idempotency_key` string
    - `uid` string — UID is the event id.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

## Changes

- **2026-08-27** (v3) `df004d06c6c2` — 18 warning
  - removed the optional property `allOf[subschema #2]/data/acknowledged_at` from the response with the `201` status
  - removed the optional property `allOf[subschema #2]/data/app_id` from the response with the `201` status
  - removed the optional property `allOf[subschema #2]/data/created_at` from the response with the `201` status
  - removed the optional property `allOf[subschema #2]/data/data` from the response with the `201` status
  - …14 more
- **2026-08-20** (v3) `c6c04abdfb6f` — 1 info
  - added the optional property `allOf[subschema #2]/data/endpoint_metadata/items/teams_webhook_url` to the response with the `201` status
- **2026-08-04** (v3) `018d37c957bf` — 1 warning, 1 info
  - removed the optional property `allOf[subschema #2]/data/metadata` from the response with the `201` status
  - added the optional property `allOf[subschema #2]/data/failure_reason` to the response with the `201` status
- **2026-07-20** (v3) `bae289777c91` — 24 breaking, 26 warning, 7 info
  - the response property `allOf[subschema #2]/data` became nullable for the status `400`
  - the response property `allOf[subschema #2]/data` became nullable for the status `401`
  - the response property `allOf[subschema #2]/data` became nullable for the status `404`
  - the response property `allOf[subschema #2]/data/acknowledged_at` became nullable for the status `201`
  - …53 more
- …earlier changes not shown

[Full history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/events/broadcast/post.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getconvoy/convoy-api-reference/revisions/df004d06c6c2/schema)