Skip to content

Commit 6a10b96

Browse files
authored
feat(KNO-12791): Add workflow recipient runs to docs (#1398)
1 parent 60b8828 commit 6a10b96

3 files changed

Lines changed: 17 additions & 0 deletions

File tree

data/sidebars/apiOverviewSidebar.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { SidebarSection } from "../types";
22

33
export const RESOURCE_ORDER = [
44
"workflows",
5+
"workflow_recipient_runs",
56
"messages",
67
"channels",
78
"users",

data/specs/api/customizations.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ resources:
8585
For a push channel, this includes device-specific tokens that map the recipient to the device they use, as well as [device metadata](/integrations/push/device-metadata) for supported providers. For chat apps, such as Slack, this includes the access token used to send notifications to a customer's Slack channel.
8686
8787
The shape of the `data` payload varies depending on the channel type; you can learn more about channel data schemas [here](/send-notifications/setting-channel-data#provider-data-requirements).
88+
workflow_recipient_runs:
89+
name: Workflow runs
90+
description: |-
91+
A workflow run represents an individual execution of a [workflow](/concepts/workflows) for a specific recipient. Use the workflow runs API to inspect the status and event history of a workflow run, including which steps were executed and any errors encountered.
8892
schedules:
8993
name: Schedules
9094
description: |-

data/specs/api/stainless.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,18 @@ resources:
280280
methods:
281281
trigger: post /v1/workflows/{key}/trigger
282282
cancel: post /v1/workflows/{key}/cancel
283+
workflow_recipient_runs:
284+
models:
285+
workflow_recipient_run: '#/components/schemas/WorkflowRecipientRun'
286+
workflow_recipient_run_detail: '#/components/schemas/WorkflowRecipientRunDetail'
287+
workflow_recipient_run_event: '#/components/schemas/WorkflowRecipientRunEvent'
288+
methods:
289+
list:
290+
endpoint: get /v1/workflow_recipient_runs
291+
get:
292+
type: http
293+
endpoint: get /v1/workflow_recipient_runs/{id}
294+
positional_params: [ id ]
283295
schedules:
284296
models:
285297
schedule: '#/components/schemas/Schedule'

0 commit comments

Comments
 (0)