Skip to main content
POST
/
v1
/
webhook
/
subscribe
Subscribe to Webhook
curl --request POST \
  --url https://api.thehyperstack.com/v1/webhook/subscribe \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": {}
}
'
{
  "success": true,
  "message": "Webhook updated successfully"
}

​
Description

This endpoint allows you to register a webhook URL to receive real-time event notifications from Hyperstack. If a subscription already exists for your organization, it will be updated with the new URL and events. Currently supported events:
  • credential.issued — triggered when a credential is successfully published

​
Headers

​
Authorization
string
required
Bearer YOUR_API_TOKEN — obtainable from Hyperstack Dashboard → Settings → API Access

​
Body Parameters

​
url
string
required
The HTTPS URL that Hyperstack will POST event payloads to. Must begin with http:// or https://.
​
events
array[string]
required
An array of event names to subscribe to. Currently supported values: ["credential.issued"].

​
Success Response Fields

​
success
boolean
Indicates whether the subscription was created or updated.
​
message
string
A confirmation message. Value: "Webhook updated successfully".

​
Responses

{
  "success": true,
  "message": "Webhook updated successfully"
}

curl -X POST "https://api.thehyperstack.com/v1/webhook/subscribe" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourapp.com/webhooks/hyperstack",
    "events": ["credential.issued"]
  }'
Last modified on February 22, 2026