List available webhook event types

Returns every event type customers can subscribe to. The dashboard subscription form reads from this endpoint, so newly registered events are immediately discoverable here.

On this page

• HTTP request
• Request Header
• Responses
• Security
• Python example
• Definitions
  • V1WebhookEvent

HTTP request

GET https://api.parsewise.ai/api/v1/webhooks/events/

Request Header

Name	Required	Type	Description
X-API-Key	Yes	string	API key with the pw_live_ prefix. See Authentication.

Responses

Status	Type	Description
200	array<V1WebhookEvent>	—

Security

• ApiKeyAuth — apiKey — in X-API-Key header. API key with pw_live_ prefix.

Python example

import os
import requests

API_KEY = os.environ["PARSEWISE_API_KEY"]
BASE_URL = "https://api.parsewise.ai/api/v1"

resp = requests.get(
    f"{BASE_URL}/webhooks/events/",
    headers={"X-API-Key": API_KEY},
)
resp.raise_for_status()
print(resp.json() if resp.content else None)

Definitions

V1WebhookEvent

One entry in GET /api/v1/webhooks/events/.

Name	Required	Type	Description
name	Yes	string	Canonical event name customers subscribe to.
description	Yes	string	Human-readable description.
group	Yes	string	Display group for the dashboard form.