Skip to main content

Get Available Webhook Events

Retrieve all available webhook event types, categorized by event category.
curl -X GET https://api.stellarstack.io/webhooks/events \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

events
string[]
Array of all available event types
categorized
object
Events grouped by category

List Webhooks

Get all webhooks for the authenticated user.
curl -X GET https://api.stellarstack.io/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Returns an array of webhook objects.
id
string
Unique webhook identifier
url
string
Webhook delivery URL
events
string[]
Event types this webhook listens to
serverId
string
Server ID if webhook is scoped to a specific server
enabled
boolean
Whether the webhook is enabled
provider
string
Webhook provider (currently only “discord”)
server
object
Server details if serverId is set
_count
object
createdAt
string
ISO 8601 timestamp

Get Webhook Details

Retrieve details for a specific webhook, including recent deliveries.
curl -X GET https://api.stellarstack.io/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id
string
required
Webhook ID

Response

id
string
Webhook ID
url
string
Webhook URL
events
string[]
Subscribed event types
enabled
boolean
Whether webhook is enabled
deliveries
array
Last 10 deliveries

Error Responses

error
string
Error message
404 Not Found - Webhook not found or not owned by user

Create Webhook

Create a new webhook for event notifications.
curl -X POST https://api.stellarstack.io/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://discord.com/api/webhooks/...",
    "events": ["SERVER_STARTED", "SERVER_STOPPED"],
    "serverId": "server-id-optional"
  }'

Request Body

url
string
required
Webhook delivery URL (must be a valid URL)
events
string[]
required
Array of event types to subscribe to (minimum 1)
serverId
string
Optional server ID to scope webhook to a specific server

Response

Returns the created webhook object. 201 Created - Webhook created successfully 400 Bad Request - Validation failed or invalid events
error
string
Error message
details
array
Validation error details (if validation failed)
invalidEvents
string[]
List of invalid event names (if events are invalid)
404 Not Found - Server not found or not owned by user (if serverId provided)

Update Webhook

Update an existing webhook’s configuration.
curl -X PATCH https://api.stellarstack.io/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'

Path Parameters

id
string
required
Webhook ID

Request Body

url
string
New webhook URL
events
string[]
Updated event types (minimum 1)
enabled
boolean
Enable or disable the webhook

Response

Returns the updated webhook object. 400 Bad Request - Validation failed or invalid events 404 Not Found - Webhook not found

Delete Webhook

Permanently delete a webhook.
curl -X DELETE https://api.stellarstack.io/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id
string
required
Webhook ID

Response

success
boolean
Always true on successful deletion
404 Not Found - Webhook not found

Get Webhook Deliveries

Retrieve delivery history for a webhook with pagination.
curl -X GET "https://api.stellarstack.io/webhooks/{id}/deliveries?limit=50&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id
string
required
Webhook ID

Query Parameters

limit
number
default:"50"
Number of deliveries to return (max 100)
offset
number
default:"0"
Number of deliveries to skip for pagination

Response

deliveries
array
Array of delivery objects
total
number
Total number of deliveries
limit
number
Limit used for this request
offset
number
Offset used for this request
404 Not Found - Webhook not found

Get Delivery Details

Get detailed information about a specific webhook delivery.
curl -X GET https://api.stellarstack.io/webhooks/{id}/deliveries/{deliveryId} \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id
string
required
Webhook ID
deliveryId
string
required
Delivery ID

Response

id
string
Delivery ID
webhookId
string
Webhook ID
event
string
Event type
payload
object
Event payload sent to webhook
statusCode
number
HTTP status code from webhook endpoint
response
string
Response body from webhook endpoint (truncated to 5000 characters)
attempts
number
Number of delivery attempts
deliveredAt
string
ISO 8601 timestamp of successful delivery
createdAt
string
ISO 8601 timestamp
404 Not Found - Webhook or delivery not found

Retry Failed Delivery

Retry a failed webhook delivery.
curl -X POST https://api.stellarstack.io/webhooks/{id}/deliveries/{deliveryId}/retry \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id
string
required
Webhook ID
deliveryId
string
required
Delivery ID to retry

Response

success
boolean
Whether the retry was successful
deliveryId
string
ID of the new delivery created for the retry
statusCode
number
HTTP status code from webhook endpoint
error
string
Error message if retry failed
404 Not Found - Webhook or delivery not found 500 Internal Server Error - Retry failed

Test Webhook

Send a test payload to a webhook URL to verify it’s working.
curl -X POST https://api.stellarstack.io/webhooks/{id}/test \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id
string
required
Webhook ID

Response

success
boolean
Whether the test was successful
error
string
Error message if test failed
404 Not Found - Webhook not found 500 Internal Server Error - Test failed

Build docs developers (and LLMs) love