# Publish to a status page

`POST https://evohub.io/api/v1/incidents/{id}/publish`

Part of the [On-Call API](https://docs-dev.evohub.io/oncall.md) reference · operationId `publishIncident`.

Publishes the incident to one of the organization's status pages. From then
on status changes, timeline entries and title or severity edits are relayed
to the public incident.

`impact` defaults to the incident's severity. `message` is the first public
update; it defaults to the incident's summary, or a generic line.

**Permission (API-key scope):** `oncall:incident:write`.

## Authorization

Any one of:

- `bearerAuth` (oncall:incident:write)
- `apiKeyHeader` (oncall:incident:write)

Where:

- `bearerAuth`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `apiKeyHeader`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Path parameters

- `id` (string, required, example `2e7f9a1b-3c4d-4e5f-8a9b-0c1d2e3f4a5b`): The incident's id.

## Request body (required)

Content type: `application/json`

Type: `IncidentPublish`

- `page_id` (string, required): The status page to publish to.
- `impact` (string, one of `none`, `minor`, `major`, `critical`): Defaults to the incident's severity.
- `affected_component_ids` (array of string)
- `message` (string): The first public update.

## Responses

### 201 — Published.

Content type: `application/json`

Type: `object`

- `data` (IncidentPublication, required)
  - `published` (boolean, required)
  - `status_page_id` (string)
  - `status_incident_id` (string): The incident's id on the status page.
- `success` (boolean, required, value `true`)

### 400 — The body is not JSON (`INVALID_BODY`), `page_id` is empty, or `impact` is not one of `none`, `minor`, `major`, `critical` (`VALIDATION_FAILED`).

Content type: `application/json`

Type: `ValidationError`

- `error` (object, required)
  - `code` (string, required, value `VALIDATION_FAILED`)
  - `message` (string, required)
  - `details` (array of object, required)
    - `field` (string)
    - `message` (string)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 404 — No incident with this id in your organization (`NOT_FOUND`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 409 — The incident is already published (`ALREADY_PUBLISHED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 429 — Too many requests (`RATE_LIMITED`). Wait `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 502 — The status page did not accept the incident (`STATUS_PUBLISH_FAILED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

## Example request

```bash
curl -X POST 'https://evohub.io/api/v1/incidents/2e7f9a1b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/publish' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "impact": "major",
  "message": "We are investigating failed card payments.",
  "page_id": "page_1f2e3d4c",
  "affected_component_ids": [
    "comp_payments"
  ]
}'
```