staqlydocs
REST APIAPI referenceWebhooks

Get a webhook

Get a webhook

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/webhooks/{id}

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Response Body

OK

application/json
  1. response
id*string
url*string
description*string
secret*string

HMAC key; X-Staqly-Signature = sha256=hex(HMAC_SHA256(secret, timestamp + '.' + body)). Shown in full only in the create response and after rotate_secret; elsewhere masked as whsec_****<last 4>.

events*array<string>

Exact names or globs: "", "post."

collection_ids*array<string>

Empty means all collections

active*boolean
timeout_ms*integer
max_attempts*integer
created_at*string
updated_at*string
curl -X GET 'https://staqly.example.com/v1/webhooks/string'
{  "id": "string",  "url": "string",  "description": "string",  "secret": "string",  "events": [    "string"  ],  "collection_ids": [    "string"  ],  "active": true,  "timeout_ms": 0,  "max_attempts": 0,  "created_at": "string",  "updated_at": "string"}