SparQDocs
GuidesAPI referencesparqhq.ai
API referenceWebhooks

Create Webhook

POST
/v1/admin/workspaces/{workspace_id}/webhooks

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

The signing secret is returned once, in this response only.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body

Body of POST /v1/admin/workspaces/{workspace_id}/webhooks.

url*Url

HTTPS only.

Formaturi
Length1 <= length
topics*array<>
Items1 <= items <= 50
description?|null

Response Body

Successful Response

application/json
  1. response

The endpoint and its signing secret. The secret is shown once, in this response only.

webhook*
secret*Secret

Used to check Sparq-Signature. Store it now.

Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "topics": [    "run.completed"  ]}'
Example Response
{  "webhook": {    "webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",    "url": "http://example.com",    "topics": [      "string"    ],    "description": "string",    "status": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "secret": "string"}

Review Mcp Server POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.

Delete Webhook DELETE

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.