Listing Webhook Events via the API

Overview

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

Send your API key as a Bearer token. See 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.

Example request

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

Example response

{
  "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 for what it means, then subscribe a webhook to it.