# Listing Webhook Events via the API

Source: https://docs.astalty.com.au/developers/webhooks/listing-webhook-events-via-the-api

> Fetch the current list of subscribable webhook event types directly from the API, instead of the static events table.

Astalty Premium - This feature is part of the Astalty Premium plan. See What Premium includes.

## Overview

[Supported webhook events](https://docs.astalty.com.au/developers/webhooks/supported-webhook-events) lists event types with plain-English descriptions. Use this endpoint to build an event-type picker or configuration from the API's current list. The list includes events for features your account may not have; an event only occurs when its feature is available and used.

## Endpoint

|            |                                                                |
| ---------- | -------------------------------------------------------------- |
| **Method** | `GET`                                                          |
| **URL**    | `https://api.app.astalty.com.au/public/v1/webhook-event-types` |

Send your API key as a **Bearer** token. See [Authentication](https://docs.astalty.com.au/developers/api/authentication). A **Read Only** key can list event types. Use a **Full Access** key to manage webhooks through the API. For access within Astalty, see [Setting Up a Webhook](https://docs.astalty.com.au/developers/webhooks/setting-up-a-webhook).

## Example request

```bash
curl https://api.app.astalty.com.au/public/v1/webhook-event-types \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

## Example response

```json
{
  "data": [
    { "value": "candidate.created" },
    { "value": "participant.created" },
    { "value": "task.created" },
    { "value": "user.invited" }
  ]
}
```

Each object has a single `value` field holding the event type string. There's no description field, so cross-reference a value against [Supported webhook events](https://docs.astalty.com.au/developers/webhooks/supported-webhook-events) for what it means, then [subscribe a webhook to it](https://docs.astalty.com.au/developers/webhooks/setting-up-a-webhook#create-a-webhook).

> **Source of truth**
>
> This endpoint returns the API's current event type names. If [Supported webhook events](https://docs.astalty.com.au/developers/webhooks/supported-webhook-events) differs, use the response for accepted names. An event appearing in this list does not enable its feature on your account.