Skip to main content

Automations and API Keys

Automations and API Keys help you connect Storydoc with external tools so you can create personalized story versions at scale, monitor usage and performance, and manage access securely.

Jack avatar
Written by Jack
Updated over 2 weeks ago

Storydoc API

The Storydoc API lets external tools send requests to Storydoc to create and manage story versions programmatically. This is the foundation for workflows like creating a personalized version for every lead, generating versions from a spreadsheet, or writing the Storydoc link back into your CRM.

API documentation
Use the API documentation for endpoints, authentication, request examples, and response fields: https://docs.storydoc.com/

What the API can do

  • Create a new story version from a template (each version gets a unique URL you can track independently).

  • Update an existing version.

  • Read story and account details (useful for mapping IDs and validating access).

Automations in Storydoc

The Automations area is the in-product control center for:

  • Creating and managing API keys

  • Monitoring usage across keys (calls, success rate, errors, credits)

  • Opening detailed insights per key (latency, error breakdown, request details)

  • Exporting insights to CSV

  • Jumping from a specific API call to Analytics to review performance for the version created by that call

How automation usually works

Most Storydoc automation flows follow this pattern:

  1. Prepare a Storydoc template
    Start with a base story that you want to personalize repeatedly.

  2. Choose the system that triggers automation
    Common triggers are:

    • A CRM event (new lead, deal moved stage, meeting booked)

    • A new row in Google Sheets

    • A form submission

  3. Create a version via the API
    Your tool sends a request to the Storydoc API endpoint that creates a new version. The response includes the version URL (and other URLs), which you can store or send.

  4. Write the version link back to your workflow
    Save the URL in your CRM record, spreadsheet row, or outreach tool so it is ready to use.

If you are using Zapier, the connection step includes pasting your Storydoc API key during setup.

API keys

API keys authenticate external tools that call the Storydoc API. Each key is unique, managed independently, and can be scoped to reduce risk.

Create an API key

  1. Open Automations.

  2. Go to API Keys.

  3. Click Create API Key.

  4. Select the scope:

    • All stories

    • Specific story

  5. Confirm creation.

  6. Copy the generated API key.

Important: The key is shown only once after creation. Store it securely in a password manager or a secrets manager.

API key scopes

  • All stories: Use when your automation needs to work across multiple stories in the workspace.

  • Specific story: Use when the automation should access only one story. This is the recommended option whenever possible.

How the API key is used (authentication)

Most integrations pass your API key as a Bearer token in the Authorization header: Bearer <your-token>.

Manage API keys

For each API key, you can:

  • View status (Active / Inactive)

  • Revoke the key

  • Regenerate the key

  • Delete the key

  • Open detailed insights

Use separate keys per tool or workflow (for example one key for Zapier, one for an internal script). This makes troubleshooting and access management much easier.

Automations dashboard

The Automations dashboard provides an overview of automation activity, including:

  • Total API calls

  • Success rate

  • Error count

  • Credits used

  • Number and types of API keys created

Navigate from an API call to Analytics

Use this when you want to check engagement and performance for the exact version created by a specific API request.

  1. In the API calls list, open the three-dot menu on an API call.

  2. Select Analytics.

  3. You are redirected to the Analytics page, with the version created by that API call automatically filtered.

Best practices

  • Treat API keys like passwords and never share them publicly.

  • Prefer Specific story scope whenever possible.

  • Use one key per integration or workflow so you can isolate errors and revoke access without affecting other automations.

  • Review insights regularly to catch repeated errors and performance issues early.

  • If you suspect misuse, revoke or regenerate the key immediately.

Related articles

Did this answer your question?