Skip to content

Create Sheet#

Creates a Sheet (an interactive UI sheet). This workflow uses root-level metadata, and the media URL list is only present to satisfy the standard API shape.

  • Workflow ID: create-sheet

Example Request#

{
  "workflows": ["create-sheet"],
  "mediaUrls": ["https://example.com/sheet/placeholder"],
  "metadata": {
    "Title": "Subscribe Promo",
    "Url": "https://example.com/subscription",
    "Size": 75,
    "ExternalId": "sheet-ext-001"
  }
}

Metadata#

Key Type Required Remarks
Title string Yes Root-level. Sheet title.
Url url Yes Root-level. Destination URL for the sheet.
Size int No Root-level. 50, 75, or 100 (percent of screen height). Defaults to 100.
ExternalId string No Root-level. Your external identifier for the sheet.

cURL Example#

curl -X POST "https://integrations.usestoryteller.com/api/workflows/execute" \
  -H "x-storyteller-api-key: $ST_API_KEY" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "workflows": ["create-sheet"],
  "mediaUrls": ["https://example.com/sheet/placeholder"],
  "metadata": {
    "Title": "Subscribe Promo",
    "Url": "https://example.com/subscription",
    "Size": 75
  }
}
JSON