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

> 60 revisions in range; 4 could not be searched.

- **2024-07-12** `b00279e91a82` — 1 breaking, 1 info
  - removed the success response with the status `200`
  - added the success response with the status `201`
- **2024-03-26** `2ddfad646792` — 1 info
  - endpoint added
- **2024-01-30** `5a219dba9f40` — 1 breaking
  - api path removed without deprecation

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

---

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