SparQDocs
GuidesAPI referencesparqhq.ai
API referenceWebhooks

Get Webhook Payload

GET
/v1/admin/webhook-deliveries/{delivery_id}/payload

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.

Exactly what Sparq sent (or will send) in this delivery, as the receiver gets it.

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

delivery_id*Delivery 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

Response Body

Successful Response

application/json
  1. response

The JSON body Sparq POSTs to a webhook endpoint.

id*Id

UUIDv7; also the idempotency key for the receiver.

Formatuuid
topic*Topic
created_at*Created At
Formatdate-time
workspace_id*Workspace Id
Formatuuid
data?
version?Version
Default"1"
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/webhook-deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08/payload'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "topic": "string",  "created_at": "2019-08-24T14:15:22Z",  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",  "data": {},  "version": "1"}

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.

List Webhook Deliveries GET

> **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.