Create a webhook endpoint

Browser-session account endpoint. Registers an HTTPS webhook endpoint and returns the HMAC signing secret once.

post/api/webhooks/endpoints

Request

  • Base URL: https://gstcranes.com
  • URL: https://gstcranes.com/api/webhooks/endpoints
  • Auth: API key in cookie auth_session

Headers

GST-API-Versionstring
Example:2026-07-06

Optional version pin. Omit for the current public API contract, or send 2026-07-06 for explicit agent integrations.

Request body

urlstring uri required
eventsWebhookEvent[] required

Example request

{
  "url": "https://example.com/gst-webhook"
}

Response

Webhook endpoint created. The signing secret is returned once.

idstring required
urlstring uri required
eventsWebhookEvent[] required
status'active' | 'disabled' required
created_atinteger required
updated_atinteger required
last_delivery_atinteger nullable
last_statusinteger nullable
last_errorstring nullable

Example response

{
  "id": "we_abc123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.