Skip to main content

Webhooks

Webhooks let you integrate Stockaj with external systems by sending real-time HTTP notifications when events occur in your workspace.

info

Webhooks are available on Professional plans and above.

How Webhooks Work

When an event occurs in Stockaj (e.g., a rental is created), Stockaj sends an HTTP POST request to your configured URL with the event details.

Your App ← POST ← Stockaj
{
"event": "rent.created",
"data": { ... },
"timestamp": "2025-01-15T10:30:00Z"
}

Managing Webhooks

Navigate to Settings → Webhooks to manage your webhooks.

Screenshot needed

screenshot-webhooks-list.png — The webhooks management page showing configured webhooks with status and delivery counts.

Creating a Webhook

  1. Go to Settings → Webhooks and click + New Webhook.
  2. Configure:
FieldRequiredDescription
NameYesA descriptive name (e.g., "Notify Slack on new rentals")
URLYesThe HTTPS endpoint to receive events
EventsYesWhich events trigger this webhook
TimeoutNoRequest timeout in seconds (1-30, default: 10)
  1. Click Create.
  2. Copy the secret — it's shown only once! You'll need it to verify webhook signatures.

Available Events

EventDescription
*All events (wildcard)
rent.createdA new rental was created
rent.updatedA rental was updated
rent.status_changedA rental's status changed
rent.deletedA rental was deleted
item.createdA new item was created
item.updatedAn item was updated
item.deletedAn item was deleted
item.low_stockAn item dropped below its minimum quantity
renter.createdA new renter was created
renter.updatedA renter was updated
renter.deletedA renter was deleted

Webhook Security

Each webhook has a secret key used to sign payloads. Verify the signature on your end to ensure requests are genuinely from Stockaj.

The signature is sent in the request headers. Compare it against an HMAC-SHA256 hash of the payload using your secret.

Regenerating Secrets

If your secret is compromised:

  1. Go to the webhook's settings.
  2. Click Regenerate Secret.
  3. Update your server with the new secret.

Testing Webhooks

Click Send Test on any webhook to send a test payload to your URL. This helps verify your integration is working correctly.

note

Test events are rate-limited to prevent abuse.

Delivery Logs

Each webhook tracks its delivery history. Click on a webhook and go to Deliveries to see:

  • Request payload
  • Response status code
  • Response time
  • Success/failure status
Screenshot needed

screenshot-webhook-deliveries.png — The webhook delivery log showing past deliveries with status codes and response times.

Webhook Limits

PlanMax Webhooks
Free0
Starter0
Professional10
EnterpriseUnlimited