---
title: "Notify about new releases. The release settings must be set to \"event\"."
method: POST
path: "/events/releases"
tags: ["events", "default"]
---

# Notify about new releases. The release settings must be set to "event".

`POST /events/releases`

## Request

- Base URL: `{{ server_url }}/v1`
- URL: `{{ server_url }}/v1/events/releases`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/athenian/apis/title/docs/events/releases/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- ReleaseNotification[]: Request body of `/events/releases`: list of release notifications.
  - `repository` string, required: Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No ".git" should be appended. We support a special syntax for repository sets: "{reposet id}" adds all the repositories from the given set.
  - `commit` string, required: Commit hash, either short (7 chars) or long (40 chars) form.
  - `name` string, nullable: Release name. The value may not contain \n - new line character, and ' - single quote.
  - `author` string: Release author.
  - `url` string, url: Release URL.
  - `published_at` string, date-time: When the release was created. If missing, set to `now()`.

## Response `200`

Summary of the accepted and the rejected releases.

- ReleaseNotificationStatus[]: Response from `/events/releases`. The status of each release notification in the order of `NotifyReleasesRequest`.

## Other responses

- `400`: The request is invalid.
- `403`: Calling user is not allowed to access the specified repositories.
- `404`: The specified account does not exist or the user is not a member.
- `422`: The account's installation has not finished yet.

## Changes

- **2023-01-13** `d08637dcd231`: 1 breaking, 1 info
  - added the pattern `^([^'\s]| ){1,100}$` to the request property `items/name`
  - the request property `items/name` became nullable

[Operation history](https://skmtc.dev/athenian/apis/title/changes/events/releases/post.md)

---

[API](https://skmtc.dev/athenian/apis/title.md) - [All operations](https://skmtc.dev/athenian/apis/title/llms.txt) - [OpenAPI document](https://skmtc.dev/athenian/apis/title/revisions/110c9f7cffdd?raw)