Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions data/sidebars/apiOverviewSidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { SidebarSection } from "../types";

export const RESOURCE_ORDER = [
"workflows",
"workflow_recipient_runs",
"messages",
"channels",
"users",
Expand Down
4 changes: 4 additions & 0 deletions data/specs/api/customizations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ resources:
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.

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).
workflow_recipient_runs:
name: Workflow runs
description: |-
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.
schedules:
name: Schedules
description: |-
Expand Down
12 changes: 12 additions & 0 deletions data/specs/api/stainless.yml
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,18 @@ resources:
methods:
trigger: post /v1/workflows/{key}/trigger
cancel: post /v1/workflows/{key}/cancel
workflow_recipient_runs:
models:
workflow_recipient_run: '#/components/schemas/WorkflowRecipientRun'
workflow_recipient_run_detail: '#/components/schemas/WorkflowRecipientRunDetail'
workflow_recipient_run_event: '#/components/schemas/WorkflowRecipientRunEvent'
methods:
list:
endpoint: get /v1/workflow_recipient_runs
get:
type: http
endpoint: get /v1/workflow_recipient_runs/{id}
positional_params: [ id ]
schedules:
models:
schedule: '#/components/schemas/Schedule'
Expand Down
Loading