Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stellartools.dev/llms.txt

Use this file to discover all available pages before exploring further.

Webhook endpoints receive event notifications from StellarTools when things happen in your account. See the Webhooks guide for the full list of event types and how to handle deliveries.

​
The webhook object

​
id
string
Unique identifier. Prefixed with wh_.
​
object
string
Always "webhook".
​
name
string
A label for this endpoint.
​
url
string
The HTTPS URL that receives event POSTs.
​
events
array
List of event types this endpoint is subscribed to.
​
is_disabled
boolean
When true, deliveries to this endpoint are suspended.
​
description
string
Optional description.
​
created_at
string
ISO 8601 timestamp.
​
updated_at
string
ISO 8601 timestamp.

​
Create a webhook

POST /webhooks 
curl https://api.stellartools.dev/webhooks \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production handler",
    "url": "https://yourapp.com/webhooks",
    "events": ["payment.confirmed", "subscription.canceled"]
  }'

​
Body

​
name
string
required
Label for this endpoint.
​
url
string
required
The HTTPS URL to send events to.
​
events
array
required
Event types to subscribe to. At least one required. See event types.
​
description
string
Optional description.

​
Retrieve a webhook

GET /webhooks/{id} 
curl https://api.stellartools.dev/webhooks/wh_01jx... \
  -H "x-api-key: YOUR_API_KEY"

​
Update a webhook

PUT /webhooks/{id} 
curl -X PUT https://api.stellartools.dev/webhooks/wh_01jx... \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "is_disabled": true }'

​
Body

​
name
string
New label.
​
url
string
New destination URL.
​
events
array
Updated event type list. At least one required.
​
is_disabled
boolean
Set to true to pause deliveries, false to resume.
​
description
string
New description.

​
Delete a webhook

DELETE /webhooks/{id} 
curl -X DELETE https://api.stellartools.dev/webhooks/wh_01jx... \
  -H "x-api-key: YOUR_API_KEY"