Authorization
bearerAuth webhooks:readIn: header
Scope: webhooks:read
Path Parameters
^whe_[A-Za-z0-9_-]{16}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/webhooks/string"{ "data": { "id": "string", "url": "http://example.com", "description": "string", "events": [ "process.completed" ], "enabled": true, "disabledReason": "disabled_by_user", "disabledAt": "2019-08-24T14:15:22Z", "failingSince": "2019-08-24T14:15:22Z", "lastSuccessAt": "2019-08-24T14:15:22Z", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "links": { "self": "string", "deliveries": "string" } }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Get billing cycle credits GET
This billing cycle's credits and the next plan refill. Matches the Workspace Credits card on the account usage page. The period is the plan's monthly renewal window (yearly plans are divided into monthly windows), or the UTC calendar month for a workspace without an active plan. credits.available is the workspace's Yapper credit balance; GET /usage reports a linked external wallet.
Read a workspace item GET
Reads one workspace item. A folder returns its direct children; a text document returns its text a page at a time (pass nextOffset as offset for the rest); another uploaded file returns its name, type, size and download URL; an image, video or audio item returns its asset, shaped like GET /assets/{assetId}. Only item is returned when the backing record is gone. Uses the processes:read scope.