SparQDocs
GuidesAPI referencesparqhq.ai
API referenceWebhooks

Redeliver Webhook

POST
/v1/admin/webhook-deliveries/{delivery_id}/redeliver

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

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

Response Body

Successful Response

application/json
  1. response
delivery_id*Delivery Id
Formatuuid
webhook_id*Webhook Id
Formatuuid
topic*Topic
status*Status

'pending', 'delivered', 'failed' or 'dead'; an open set.

attempts*Attempts
Range0 <= value
last_attempt_at?|null
next_attempt_at?|null
response_status?|null
created_at*Created At
Formatdate-time
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/webhook-deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08/redeliver'
Example Response
{  "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"}

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.

Test Webhook 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. Send a signed test delivery now; the result is the delivery.