/v1/incoming-webhook/{workspaceId}

Webhook
POST <baseUrl>/v1/incoming-webhook/{workspaceId}

POST Receive incoming webhook for a workspace

Receives a webhook for a given workspace. This endpoint expects a POST request and requires authentication via API key or bearer token.

Parameters

Name In Required Type Description
workspaceId path Required [string] The workspace identifier.

Request Body

Optional
application/json
Schema: WebhookPayload
deploymentExample - Deployment event payload 
{
  "data": {
    "Environment": "production",
    "deploymentId": "deploy-456",
    "status": "completed",
    "version": "1.2.3"
  },
  "event": "deployment",
  "timestamp": "2025-05-14T22:05:00Z"
}
notificationExample - Notification event payload 
{
  "data": {
    "message": "System maintenance scheduled",
    "priority": "high",
    "type": "system_alert"
  },
  "event": "Notification",
  "timestamp": "2025-05-14T21:00:00Z"
}

Responses

200 Webhook received successfully.
application/json
Schema: WebhookResponse
success - Success response 
{
  "id": "webhook-789",
  "message": "Webhook received",
  "receivedAt": "2025-05-14T21:00:05Z",
  "status": "success"
}
400 Bad request - invalid payload format
application/json
Schema: ErrorResponse
401 Unauthorized
404 Workspace not found
500 Internal server error

Security

  • apiKeyAuth [apiKey]
    API Key authentication. Use the X-API-KEY header (generated from the Vaktum portal) to authenticate directly to a workspace.
    In: header
    Name: X-API-KEY
  • bearerAuth [http]
    OAuth2 authentication. Use the Authorization header with a Bearer token. Also provide X-WORKSPACE-ID header for workspace context.
    Scheme: bearer
    Bearer Format: JWT