Webhooks

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

string

Unique identifier. Prefixed with wh_.

string

Always "webhook".

string

A label for this endpoint.

string

The HTTPS URL that receives event POSTs.

array

List of event types this endpoint is subscribed to.

boolean

When true, deliveries to this endpoint are suspended.

string

Optional description.

string

ISO 8601 timestamp.

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

string

required

Label for this endpoint.

string

required

The HTTPS URL to send events to.

array

required

Event types to subscribe to. At least one required. See event types.

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

string

New label.

string

New destination URL.

array

Updated event type list. At least one required.

boolean

Set to true to pause deliveries, false to resume.

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"

Overview

Resources

Reference Data

The webhook object

Create a webhook

Body

Retrieve a webhook

Update a webhook

Body

Delete a webhook

​The webhook object

​Create a webhook

​Body

​Retrieve a webhook

​Update a webhook

​Body

​Delete a webhook

The webhook object

Create a webhook

Body

Retrieve a webhook

Update a webhook

Body

Delete a webhook