SparQDocs
GuidesAPI referencesparqhq.ai
API referenceWebhooks

List Webhook Deliveries

GET
/v1/admin/webhooks/{webhook_id}/deliveries

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.

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

webhook_id*Webhook Id
Formatuuid

Query Parameters

limit?Limit

Items per page (default 50, at most 200).

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

since?|null
until?|null
status?|null

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

Pass as cursor for the next page; empty at the end.

total?|

Number of matching items, only when cheap to count.

items*array<>
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff",      "webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",      "topic": "string",      "status": "string",      "attempts": 0,      "last_attempt_at": "2019-08-24T14:15:22Z",      "next_attempt_at": "2019-08-24T14:15:22Z",      "response_status": 100,      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Get Webhook Payload 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. Exactly what Sparq sent (or will send) in this delivery, as the receiver gets it.

List Webhooks 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.