# Create Webhook Subscription

`POST https://api.astroway.info/v1/webhooks/subscribe`

Subscribe to outbound webhook deliveries. Events: report-ready, transit-alert, eclipse-alert. Returns a signing_secret used to verify the X-AstroWay-Signature HMAC-SHA256 header on each delivery.

Group: Webhooks. Auth: `X-Api-Key` header. Operation ID: `webhooks_subscribe`.

## Parameters

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `fields` | query | no | string | Comma-separated dotted paths, relative to `data`, to keep in the response. A path is applied to every element of an array, so `planets.name` means the name of each planet. Paths that match nothing come back in `_fields_unmatched`; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer. |
| `precision` | query | no | integer | Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `event` | "report-ready" \| "transit-alert" \| "eclipse-alert" \| "transit-trigger" \| "retrograde-start" \| "retrograde-end" \| "return-due" \| "dasha-change" \| … | yes |  |
| `url` | string | yes |  |

```json
{
  "event": "report-ready",
  "url": "https://example.com/webhooks/astroway"
}
```

## Responses

| Status | Meaning |
|---|---|
| 200 | Successful calculation |
| 400 | Validation error |
| 401 | Missing or invalid API key |

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | number | no |  |
| `event` | string | no |  |
| `url` | string | no |  |
| `signing_secret` | string | no |  |
| `active` | boolean | no |  |
| `created_at` | string | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/webhooks/subscribe \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "event": "report-ready", "url": "https://example.com/webhooks/astroway" }'
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/webhooks_subscribe/