Webhooks
Register endpoints to receive signed events. Deliveries are retried automatically on failure.
The webhook object
idstringoptional | Unique identifier. |
namestringoptional | Label. |
urlstringoptional | HTTPS endpoint to deliver to. |
eventsstring[]optional | Subscribed events, e.g. payment.completed. |
status"ACTIVE" | "PAUSED"optional | Delivery status. |
secretMaskedstringoptional | Masked signing secret. |
createdAtstringoptional | ISO 8601 timestamp. |
Create a webhook
POST
/api/v1/webhooksnamestringrequired | Label. |
urlstringrequired | HTTPS endpoint URL. |
eventsstring[]required | One or more of payment.completed, payment.received. |
curl https://your-app.com/api/v1/webhooks \ -H "Authorization: Bearer $STELLARHOOKS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Payments", "url": "https://api.example.com/webhooks/stellarhooks", "events": ["payment.completed"] }'The
secret is returned once in the create response. Store it to verify webhook signatures.List, retrieve, delete
GET
/api/v1/webhooksGET
/api/v1/webhooks/{id}PATCH
/api/v1/webhooks/{id}DELETE
/api/v1/webhooks/{id}bash
curl https://your-app.com/api/v1/webhooks \ -H "Authorization: Bearer $STELLARHOOKS_API_KEY"For event payloads and signature verification, see Webhooks & events.