Back to API overview
Webhooks

Register a webhook

POST/v1/webhooks Bearer API key

Receive event callbacks when missions run, predictions land, or alerts fire.

Webhooks push platform events to your endpoint in near real time. Register a URL and the event types you care about; each delivery is signed so you can verify authenticity. Use webhooks to keep your systems in sync without polling.

Request body

urlrequiredstring

HTTPS endpoint that receives event payloads.

eventsrequiredstring[]

Event types to subscribe to, e.g. prediction.ready, alert.fired.

secretoptionalstring

Optional signing secret used to verify deliveries.

Response fields

idoptionalstring

Webhook identifier.

statusoptionalstring

active or disabled.

signing_secretoptionalstring

Secret used to verify the signature on each delivery.

curl -X POST https://api.satellitex.ai/v1/webhooks \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/satellitex",
    "events": ["prediction.ready", "alert.fired"]
  }'

Illustrative API — keys and identifiers are for demonstration.

Related endpoints

Ready to build with this?

Request access and we'll help you scope your first mission and provision API keys.

Request API access