Read a webhook endpoint
One endpoint of the organization, without its signing secret. An unknown or foreign id is 404. Org-level: send
no Shyni-Business header. Requires the webhooks:read scope.
ApiKeyAuth webhooks:readAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: webhooks:read
id*stringThe endpoint.
application/json- response
An organization webhook endpoint. Never carries the signing secret.
id*stringurl*stringdescription*string|nulleventTypes*array<string>Names from the webhook catalog.
mode*stringThe mode of the key that created the endpoint; it only receives events of businesses of the same mode.
"live""test"enabled*booleandisabledReason*|FAILURES = switched off after repeated failed deliveries, OWNER = switched off through the API.
"FAILURES""OWNER"nullcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X GET 'https://api.shyni.io/api/v1/webhook-endpoints/string' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
The endpoint.
{ "id": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "mode": "live", "enabled": true, "disabledReason": "FAILURES", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The resource does not exist, or belongs to a different studio.
{ "code": "NOT_FOUND", "message": "Order not found."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}