Skip to content
shuffl
Get started

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

Reference

Connections rounds API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

runs.details

Read one introduction round and its pairs

POST/api/v1/manage/runs/details

const result = await shuffl.runs.details({
  "runId": "<runId>"
});
Request fields (1)
  • runId string required
Response object
  • deliveries object[] required
    • attempts number required
    • component "bio" | "bio_invite" | "channel_notice" | "email" | "intro" | "open" required
    • errorCode null | string required
    • groupId null | string required
    • id string required
    • state "attempting" | "canceled" | "failed" | "pending" | "sent" | "unknown" required
  • groups object[] required
    • canceledAt null | string (date-time) required
    • channelId null | string required
    • deliveredAt null | string (date-time) required
    • id string required
    • ordinal number required
    • runId string required
    • teamId string required
  • members object[] required
    • groupId string required
    • member object required
      • active boolean required
      • bot boolean required
      • createdAt string (date-time) required
      • email null | string required
      • employeeNumber null | number required
      • id string required
      • name string required
      • profile object required
        • askMeAbout string[] optional
        • asks string optional
        • bio string optional
        • interests string optional
        • location string optional
        • offers string optional
        • phone string optional
        • preferredName string optional
        • pronouns string optional
        • role string optional
        • workingOn string optional
      • slackPhotoUrl null | string required
      • slackProfileLinkAt null | string (date-time) required
      • slackUserId null | string required
      • teamId string required
      • userId null | string required
    • photoUrl null | string required
  • run object required
    • completedAt null | string (date-time) required
    • config object required
      • fineTune object optional
        • commonGround 0 | 1 | 2 required
        • meetRequests boolean required
        • mentionCommonGround boolean required
        • reach "any" | "far" | "fof" required
      • groupSize number required
      • iterations number required
      • keepApart object optional
        • relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
        • strict boolean required
      • maxGroupSize number required
      • strategy string required
      • unitIds string[] optional
      • unitKind "community" | "department" | "team" optional
    • createdAt string (date-time) required
    • eligibleCount number required
    • historyFinalizedAt null | string (date-time) required
    • id string required
    • occurrence string (date-time) required
    • programId string required
    • reason null | string required
    • requestKey string required
    • revision number required
    • seed string required
    • selectedCount number required
    • status "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" required
    • teamId string required
    • workflowId null | string required
  • unmatched object[] required
    • id string required
    • name string required

runs.get

Get the durable status of a run

GET/api/v1/runs/{id}

const result = await shuffl.runs.get({
  "id": "<id>"
});
Request fields (1)
  • id string required1 to 128 characters
Response object
  • createdAt string (date-time) required
  • id string required1 to 128 characters
  • programId string required1 to 128 characters
  • reason string | null required
  • status string required

runs.list

List a program's introduction rounds

POST/api/v1/manage/runs/list

const result = await shuffl.runs.list({});
Request fields (3)
  • page number optional
  • programId string optional
  • status "all" | "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" optional
Response object
  • page number required
  • rows object[] required
    • completedAt null | string (date-time) required
    • config object required
      • fineTune object optional
        • commonGround 0 | 1 | 2 required
        • meetRequests boolean required
        • mentionCommonGround boolean required
        • reach "any" | "far" | "fof" required
      • groupSize number required
      • iterations number required
      • keepApart object optional
        • relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
        • strict boolean required
      • maxGroupSize number required
      • strategy string required
      • unitIds string[] optional
      • unitKind "community" | "department" | "team" optional
    • createdAt string (date-time) required
    • eligibleCount number required
    • historyFinalizedAt null | string (date-time) required
    • id string required
    • occurrence string (date-time) required
    • programId string required
    • reason null | string required
    • requestKey string required
    • revision number required
    • seed string required
    • selectedCount number required
    • status "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" required
    • teamId string required
    • workflowId null | string required
  • total number required

runs.dispatch

Dispatch this queued introduction run

POST/api/v1/manage/runs/dispatch

  • Write
  • Permission runs.dispatch
  • Needs a requestKey
  • Needs confirm set to runs.dispatch
const result = await shuffl.runs.dispatch({
  "runId": "<runId>",
  "confirm": "runs.dispatch",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • runId string required
  • confirm "runs.dispatch" 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
    • started boolean required
    • workflowId null | string required

runs.request

Queue introductions using a preview and idempotent request key

POST/api/v1/runs

const result = await shuffl.runs.request({
  "preview": {
    "fingerprint": "<fingerprint>",
    "revision": -9007199254740991,
    "seed": "<seed>"
  },
  "programId": "<programId>",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • preview object required
    • fingerprint string required64 to 64 characters
    • revision integer required
    • seed string required1 to 128 characters
  • programId string required1 to 128 characters
  • requestKey string required8 to 120 characters
Response object
  • id string required1 to 128 characters
  • status string required

runs.retry

Retry introduction delivery

POST/api/v1/manage/runs/retry

  • Write
  • Permission runs.retry
  • Needs a requestKey
  • Needs confirm set to runs.retry
const result = await shuffl.runs.retry({
  "runId": "<runId>",
  "confirm": "runs.retry",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • runId string required
  • confirm "runs.retry" 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
    • completedAt null | string (date-time) required
    • config object required
      • fineTune object optional
        • commonGround 0 | 1 | 2 required
        • meetRequests boolean required
        • mentionCommonGround boolean required
        • reach "any" | "far" | "fof" required
      • groupSize number required
      • iterations number required
      • keepApart object optional
        • relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
        • strict boolean required
      • maxGroupSize number required
      • strategy string required
      • unitIds string[] optional
      • unitKind "community" | "department" | "team" optional
    • createdAt string (date-time) required
    • eligibleCount number required
    • historyFinalizedAt null | string (date-time) required
    • id string required
    • occurrence string (date-time) required
    • programId string required
    • reason null | string required
    • requestKey string required
    • revision number required
    • seed string required
    • selectedCount number required
    • status "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" required
    • teamId string required
    • workflowId null | string required

runs.stopKnownFailures

Stop retrying known failed deliveries and advance the preserved monthly schedule

POST/api/v1/manage/runs/stopKnownFailures

const result = await shuffl.runs.stopKnownFailures({
  "runId": "<runId>",
  "confirm": "runs.stopKnownFailures",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • runId string required
  • confirm "runs.stopKnownFailures" 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
    • completedAt null | string (date-time) required
    • config object required
      • fineTune object optional
        • commonGround 0 | 1 | 2 required
        • meetRequests boolean required
        • mentionCommonGround boolean required
        • reach "any" | "far" | "fof" required
      • groupSize number required
      • iterations number required
      • keepApart object optional
        • relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
        • strict boolean required
      • maxGroupSize number required
      • strategy string required
      • unitIds string[] optional
      • unitKind "community" | "department" | "team" optional
    • createdAt string (date-time) required
    • eligibleCount number required
    • historyFinalizedAt null | string (date-time) required
    • id string required
    • occurrence string (date-time) required
    • programId string required
    • reason null | string required
    • requestKey string required
    • revision number required
    • seed string required
    • selectedCount number required
    • status "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" required
    • teamId string required
    • workflowId null | string required

runs.history.get

Read one introduction round imported from the previous Shuffl

POST/api/v1/manage/runs/history/get

const result = await shuffl.runs.history.get({
  "observationId": "<observationId>"
});
Request fields (1)
  • observationId string required
Response object
  • archiveSnapshotId string required
  • configuration "unknown" required
  • exactCancellationTime "unknown" required
  • exactDeliveryTime "unknown" required
  • groupMetadata object[] required
    • fields object required
    • source string required
    • sourceId string required
    • sourceSha256 string required
  • groups object[] required
    • fields object required
    • source string required
    • sourceId string required
    • sourceSha256 string required
  • kind "historical-observation" required
  • memberships object[] required
    • fields object required
    • personBinding "unresolved" required
    • source string required
    • sourceId string required
    • sourceSha256 string required
  • observationId string required
  • outcome "unknown" required
  • references object[] required
    • id string required
    • table "event_definition" | "user" required
    • tenantId string required
  • relationships object[] required
    • field string required
    • sourceId string required
    • sourceTable string required
    • status "foreign" | "matched-observation" | "mismatched" | "missing" | "unresolved" required
  • run object required
    • fields object required
    • source string required
    • sourceId string required
    • sourceSha256 string required
  • sourceRunId string required
  • sourceTenantId string required
  • workflowReadbacks object[] required
    • fields object required
    • source string required
    • sourceId string required
    • sourceSha256 string required

runs.history.list

List introduction rounds imported from the previous Shuffl

POST/api/v1/manage/runs/history/list

const result = await shuffl.runs.history.list({});
Request fields (1)
  • page number optional
Response object
  • page number required
  • rows object[] required
    • groups number required
    • kind "historical-observation" required
    • memberships number required
    • observationId string required
    • outcome "unknown" required
    • recordedCreatedAt null | string | number | false | true | string | number | boolean | null | string | number | boolean | null | any | null[] | object[] | object[] | object required
    • recordedState null | string | number | false | true | string | number | boolean | null | string | number | boolean | null | any | null[] | object[] | object[] | object required
    • sourceRunId string required
  • total number required