Listing Webhook Events via the API

Overview

Supported webhook events lists every event type with a plain-English description. To build part of your integration, such as an event-type picker or config file, from a live source instead of that table, call this endpoint to get the exact set of event types your account can currently subscribe to.

Endpoint

Send your API key as a Bearer token. See Authentication. The request also requires:

• The Webhooks feature enabled on your account.
• An API key created by the Account Owner, or by an Admin with Can manage API keys and webhooks access (see Granting API Key and Webhook Access). This is the same access that setting up a webhook needs.

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.