Retrieve a webhook subscription

Manage outbound webhook subscriptions for the authenticated tenant.

Subscriptions are tenant-scoped. Only active subscriptions are returned by list and retrieve. Deletion is permanent — the row is removed from the DB and any associated delivery rows cascade.

On this page

HTTP request

GET https://api.parsewise.ai/api/v1/webhooks/{id}/

URI Parameters

Name In Required Type Description
id path Yes string (uuid)  

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 V1WebhookSubscription

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"

id = "<uuid>"

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

Definitions

V1WebhookSubscription

Read-side serializer. Used by list / retrieve / create / update responses.

Name Required Type Description
id Yes string (uuid)  
name Yes string  
url Yes string  
subscribed_events Yes array<string> Event names this subscription is subscribed to.
is_active Yes boolean  
headers Yes object<string, string> Custom request header keys registered for this subscription. Values are always redacted.
created_at Yes string (date-time)  
updated_at Yes string (date-time)