Settings

​

API keys

​

Key types

​

Environments

• Production: Live keys for your production app
• Staging: Test keys for staging environment
• Development: Keys for local development

​

Creating keys

1. Go to Settings → API Keys
2. Click Create Key Pair
3. Select environment
4. Optionally add a description
5. Copy and securely store the secret key

​

Rotating keys

1. Create a new key pair
2. Update your applications with the new keys
3. Delete the old key pair

​

Key permissions

​

Webhooks

​

Creating a webhook

1. Click Add Webhook
2. Enter endpoint URL (must be HTTPS)
3. Select events to receive:
   • content.ready
   • content.errored
   • export.ready
4. Save

​

Webhook format

{
  "event": "content.ready",
  "data": {
    "contentId": "cnt_abc123",
    "title": "My Video",
    "duration": 45.2,
    "status": "ready"
  },
  "timestamp": "2024-02-04T12:00:00Z",
  "webhookId": "whk_xyz789"
}

​

Signature verification

X-Shortform-Signature: sha256=abc123...

const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');

  return `sha256=${expected}` === signature;
}

​

Webhook secret

1. Go to Settings → Webhooks
2. Click on a webhook
3. Copy the Signing Secret

​

Testing webhooks

1. Go to webhook detail
2. Click Send Test
3. Select event type
4. Check your endpoint received it

​

Retry policy

• 5 attempts with exponential backoff
• 1 min, 5 min, 30 min, 2 hours, 24 hours
• After all retries, event is logged as failed

​

Webhook logs

1. Go to webhook detail
2. See Recent Deliveries
3. View request/response for each attempt

​

Team management

​

Inviting members

1. Click Invite Member
2. Enter email address
3. Select role (currently all members have full access)
4. Click Send Invite

​

Managing members

• View all team members
• See last active time
• Remove members

​

Role-based access (coming soon)

​

Organization profile

​

Basic info

• Organization name: Displayed in Admin Portal
• Logo: Used in portal branding
• Billing contact: For invoices

​

Billing

• View current plan
• Usage metrics
• Invoice history
• Update payment method

​

Branded CDN domain

​

Setup

1. Enter your domain (e.g., video.yourcompany.com)
2. Create DNS CNAME record pointing to cdn.shortkit.dev
3. Click Verify
4. SSL is automatically provisioned

​

DNS configuration

​

Deep link domain

​

Configuration

• Domain: Your app’s deep link domain
• Path template: URL pattern (e.g., /watch/{contentId})
• Fallback URL: Where to send users without the app

​

Playback restrictions

​

Domain allowlist

1. Add allowed domains
2. Support wildcards (e.g., *.yourcompany.com)
3. Save

​

Additional settings

​

CDN URL expiry

• Range: 1-24 hours
• Default: 6 hours
• Shorter = more secure, longer = better for long sessions

​

Auto-captioning

​

Settings

• Enable auto-captions: Generate captions automatically
• Default languages: Languages to generate
• Apply to: New content only, or all content

​

Transcription vocabulary

1. Go to Settings → Transcription Vocabulary
2. Add words/phrases (brand names, technical terms)
3. Up to 1,000 phrases

​

Watermarking

​

Visible watermark

• Text: Watermark text (e.g., ”© Your Company”)
• Position: Corner placement
• Opacity: Transparency level
• Font size: Text size

​

Forensic watermark

​

Data export

​

Scheduled exports

1. Enable scheduled exports
2. Set frequency (daily, weekly)
3. Select data types
4. Configure delivery:
   • Webhook URL
   • Email notification

​

Integrations

​

Available integrations

• Slack: Notifications for content ready, errors
• Analytics: Send data to your analytics platform
• CMS: Connect to content management systems

​

Audit log

​

Logged events

• Configuration changes
• Team member changes
• API key operations
• Content actions

​

Filtering

• By user
• By action type
• By date range

​

Next steps