Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Operations and audit API

4 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

operations.activity

Read the workspace's recent audit activity

POST/api/v1/manage/operations/activity

const result = await shuffl.operations.activity();
Request fields (none)

This operation takes no input.

Response object[]
  • action string required
  • actorId null | string required
  • actorName string required
  • createdAt string (date-time) required
  • details object required
  • entityId null | string required
  • entityName null | string required
  • id string required
  • summary string required
  • teamId string required

operations.status

Read the workspace delivery and provider health summary

POST/api/v1/manage/operations/status

const result = await shuffl.operations.status();
Request fields (none)

This operation takes no input.

Response object
  • inbound object[] required
    • errorCode null | string required
    • id string required
    • provider string required
    • status "failed" | "processed" | "queued" required
  • unknown object[] required
    • code null | string required
    • component "bio" | "bio_invite" | "channel_notice" | "email" | "intro" | "open" required
    • id string required
    • updatedAt string (date-time) required

operations.dispatchInbox

Resume already-admitted team provider events and support delivery

POST/api/v1/manage/operations/dispatchInbox

const result = await shuffl.operations.dispatchInbox({
  "confirm": "operations.dispatchInbox",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • confirm "operations.dispatchInbox" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • workflowId string required

operations.reconcile

Reconcile an externally verified delivery outcome

POST/api/v1/manage/operations/reconcile

const result = await shuffl.operations.reconcile({
  "deliveryId": "<deliveryId>",
  "outcome": "confirmed_absent",
  "reason": "<reason>",
  "confirm": "operations.reconcile",
  "requestKey": "a-new-unique-key"
});
Request fields (6)
  • deliveryId string required
  • outcome "confirmed_absent" | "confirmed_sent" required
  • reason string required
  • receipt string optional
  • confirm "operations.reconcile" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • reconciled boolean required