SAHMK
Developers API

Realtime Event Engine

WebSocket streaming, event webhooks, payload schemas, rule conditions, delivery lifecycle, signature verification, event history, and errors.

← Back to API docs

Viewing: Event Webhooks

Event Webhooks

Create and verify webhook destinations for Realtime Event Engine delivery.

POST /api/v1/webhooks/

Create a webhook destination for Realtime Event Engine notifications.

Endpoint

https://app.sahmk.sa/api/v1/webhooks/

Parameters

(*) Required

ParameterTypeExample
url *stringhttps://example.com/hooks/sahmk
name stringTrading Production Hook

Authentication uses X-API-Key: YOUR_API_KEY.

  • Required: url (HTTPS destination URL)
  • Optional: name (friendly label)
  • Verification: a challenge handshake is sent on create; success requires HTTP 200.
  • Secret handling: signing_secret is returned only on create and is not included in list/get responses.
200 OKapplication/json
{
  "id": 19,
  "url": "https://example.com/hooks/sahmk",
  "name": "Trading Production Hook",
  "signing_secret": "xxxxxxxxxxxxxxxx",
  "is_verified": false,
  "is_active": true,
  "created_at": "2026-05-08T13:30:12+03:00"
}

Next step: continue with Signature Verification and Delivery Lifecycle for production readiness.

← PreviousWebSocket Streaming
Next →Payload Reference