> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hae webhook

> Hae yksi webhook

Hae yksi webhook. Vastaus ei koskaan sisällä allekirjoitussalaisuutta.

> [!NOTE]
>
> Vaatii `webhooks_manage`-scopen.

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Webhookin tunniste (UUID).

## Vastaus

Onnistuessaan API palauttaa tilakoodin `200 OK` sekä webhookin.

**id** `string` *required*

Webhookin tunniste (UUID).

**url** `string` *required*

HTTPS-osoite, johon Aniva lähettää tapahtumat.

**description** `string`

Vapaamuotoinen teksti omaan käyttöösi. Voi olla `null`.

**enabled\_events** `string[]` *required*

[Tapahtumatyypit](https://docs.anivahealth.com/fi/concepts/webhooks.md#tapahtumat), joita tämä webhook vastaanottaa. `*` tarkoittaa kaikkia tyyppejä.

**alert\_emails** `string[]` *required*

Osoitteet, joihin Aniva lähettää sähköpostia, kun toimitukset epäonnistuvat toistuvasti.

**status** `string` *required*

`enabled` tai `disabled`.

**disabled\_at** `string`

ISO 8601 UTC -aikaleima, jolloin webhook poistettiin käytöstä. `null`, kun webhook on käytössä.

**disabled\_reason** `string`

Syy siihen, miksi webhook poistettiin käytöstä. Katso [Virheilmoitukset](https://docs.anivahealth.com/fi/concepts/webhooks.md#virheilmoitukset). `null`,
kun webhook on käytössä.

**failing\_since** `string`

ISO 8601 UTC -aikaleima, jolloin nykyinen epäonnistumisputki alkoi. `null`, kun viimeisin toimitus onnistui.

**previous\_secret\_expires\_at** `string`

ISO 8601 UTC -aikaleima, jolloin edellinen salaisuus lakkaa allekirjoittamasta. `null`, kun vaihto ei ole käynnissä.

**created\_at** `string` *required*

ISO 8601 UTC -aikaleima, jolloin webhook luotiin.

**updated\_at** `string` *required*

Viimeisimmän muutoksen ISO 8601 UTC -aikaleima.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Virheellinen pyyntö. Katso `error`-viesti. |
| `401` | Virheellinen API-avain. |
| `403` | API-avain puuttuu tai siltä puuttuu `webhooks_manage`-scope. |
| `404` | Webhookia ei löytynyt, tai se kuuluu toiselle API-avaimelle. |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
  "url": "https://partner.example.com/webhooks/aniva",
  "description": "Production",
  "enabled_events": [
    "appointment.confirmed",
    "appointment.results.completed",
    "home_kit_order.results.completed"
  ],
  "alert_emails": ["ops@partner.example.com"],
  "status": "enabled",
  "disabled_at": null,
  "disabled_reason": null,
  "failing_since": null,
  "previous_secret_expires_at": null,
  "created_at": "2026-10-15T08:00:00.000Z",
  "updated_at": "2026-10-15T08:00:00.000Z"
}
```

```json 404 theme={null}
{
  "error": "Webhook not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.