# Developer documentation

Build integrations with Styrar: receive signed webhook events, call the REST API, and automate your social workflow.

## Team and Agency plans

REST API access and API keys are included on Team and Agency plans only. Free and Solo workspaces do not include API access. Upgrade in Settings → Billing or compare plans on the pricing page.

## Getting started

1. Read the API introduction for base URL, authentication, and response codes.
2. Choose webhooks for push events or the REST API for on-demand reads and writes.
3. Review event types and set up link conversion tracking or bio analytics when needed.
4. Create API keys under Settings → API keys on a Team or Agency plan.

## API base URL

```
https://api.styrar.com/v1
```

## Documentation

- [Webhooks](https://styrar.com/en/docs/webhooks) ([markdown](https://styrar.com/en/docs/webhooks.md))
  - Receive signed HTTP notifications when links, campaigns, and posts change in your workspace.
- [Set up an endpoint](https://styrar.com/en/docs/webhooks-setup) ([markdown](https://styrar.com/en/docs/webhooks-setup.md))
  - Create a webhook endpoint in the dashboard or via the API, send a test event, and go live.
- [Verify signatures](https://styrar.com/en/docs/webhooks-signatures) ([markdown](https://styrar.com/en/docs/webhooks-signatures.md))
  - Validate Styrar-Signature on every delivery with HMAC-SHA256.
- [Webhook API](https://styrar.com/en/docs/webhooks-api) ([markdown](https://styrar.com/en/docs/webhooks-api.md))
  - List endpoints, inspect deliveries, and manage webhook subscriptions via the REST API.
- [Events](https://styrar.com/en/docs/events) ([markdown](https://styrar.com/en/docs/events.md))
  - Outbound event envelope and when each event type fires.
- [Event types](https://styrar.com/en/docs/events-types) ([markdown](https://styrar.com/en/docs/events-types.md))
  - Payload reference for link, campaign, post, and test events.
- [Links](https://styrar.com/en/docs/links) ([markdown](https://styrar.com/en/docs/links.md))
  - Short links, A/B tests, and conversion pixel on destination pages.
- [Conversion pixel](https://styrar.com/en/docs/conversion-pixel) ([markdown](https://styrar.com/en/docs/conversion-pixel.md))
  - Track conversions on destination pages you don't control, attributed back to the originating click and A/B variant.
- [Conversion pixel on Shopify](https://styrar.com/en/docs/pixel-shopify) ([markdown](https://styrar.com/en/docs/pixel-shopify.md))
  - Install the Styrar conversion pixel on Shopify via the Styrar app (recommended) or a Custom Pixel.
- [Conversion pixel on WordPress](https://styrar.com/en/docs/pixel-wordpress) ([markdown](https://styrar.com/en/docs/pixel-wordpress.md))
  - Install the Styrar conversion pixel on a WordPress site, with or without a plugin.
- [Conversion pixel on Wix](https://styrar.com/en/docs/pixel-wix) ([markdown](https://styrar.com/en/docs/pixel-wix.md))
  - Install the Styrar conversion pixel on Wix using Custom Code, with or without Velo.
- [Conversion pixel on Framer](https://styrar.com/en/docs/pixel-framer) ([markdown](https://styrar.com/en/docs/pixel-framer.md))
  - Install the Styrar conversion pixel on a Framer site using Custom Code.
- [Reporting conversions server-side](https://styrar.com/en/docs/pixel-server-side) ([markdown](https://styrar.com/en/docs/pixel-server-side.md))
  - Report conversions to Styrar from your own backend in Node.js, Python, or Ruby on Rails.
- [Tracking and analytics](https://styrar.com/en/docs/tracking) ([markdown](https://styrar.com/en/docs/tracking.md))
  - Bio page trackers and analytics API overview.
- [Bio page trackers](https://styrar.com/en/docs/analytics-and-pixels) ([markdown](https://styrar.com/en/docs/analytics-and-pixels.md))
  - Add Google Analytics, Meta, X, TikTok, LinkedIn, Pinterest, Snapchat, or Google Tag Manager to your bio page, gated behind cookie consent.
- [Authentication](https://styrar.com/en/docs/authentication) ([markdown](https://styrar.com/en/docs/authentication.md))
  - API keys and Bearer tokens for the REST API. Team and Agency plans only.
- [Introduction](https://styrar.com/en/docs/api-reference) ([markdown](https://styrar.com/en/docs/api-reference.md))
  - Base URL, authentication, response codes, rate limits, and pagination.
- [Endpoints](https://styrar.com/en/docs/api-endpoints) ([markdown](https://styrar.com/en/docs/api-endpoints.md))
  - Index of REST API resource pages: posts, links, bio, Sites, campaigns, media, analytics, and more.
- [Posts](https://styrar.com/en/docs/api-posts) ([markdown](https://styrar.com/en/docs/api-posts.md))
  - Schedule, publish, and manage social posts via the REST API.
- [Short links](https://styrar.com/en/docs/api-links) ([markdown](https://styrar.com/en/docs/api-links.md))
  - Short links, bulk operations, QR, routing rules, and A/B experiments.
- [Bio pages](https://styrar.com/en/docs/api-bio) ([markdown](https://styrar.com/en/docs/api-bio.md))
  - Bio pages, versions, preview, booking, and blog routes.
- [Sites (beta)](https://styrar.com/en/docs/api-sites) ([markdown](https://styrar.com/en/docs/api-sites.md))
  - Beta: Sites websites, theme packages, versions, and publish.
- [Campaigns](https://styrar.com/en/docs/api-campaigns) ([markdown](https://styrar.com/en/docs/api-campaigns.md))
  - Campaign CRUD for posts and short-link attribution.
- [Media](https://styrar.com/en/docs/api-media) ([markdown](https://styrar.com/en/docs/api-media.md))
  - Upload files and refresh short-lived library view URLs.
- [Social accounts](https://styrar.com/en/docs/api-social-accounts) ([markdown](https://styrar.com/en/docs/api-social-accounts.md))
  - List connected social accounts for publish targets.
- [Analytics](https://styrar.com/en/docs/api-analytics) ([markdown](https://styrar.com/en/docs/api-analytics.md))
  - Social, link, bio, and Sites analytics routes.
- [Webhooks API](https://styrar.com/en/docs/api-webhooks) ([markdown](https://styrar.com/en/docs/api-webhooks.md))
  - Manage webhook endpoints, event types, and deliveries.
- [Community](https://styrar.com/en/docs/api-community) ([markdown](https://styrar.com/en/docs/api-community.md))
  - Comments inbox, sync, reply templates, and moderation.
- [Content planning](https://styrar.com/en/docs/api-content-planning) ([markdown](https://styrar.com/en/docs/api-content-planning.md))
  - Kanban board, stages, work items, and tags.
- [Saved mentions](https://styrar.com/en/docs/api-saved-mentions) ([markdown](https://styrar.com/en/docs/api-saved-mentions.md))
  - Workspace-saved @mention shortcuts for compose and publish.
- [Automations and approvals](https://styrar.com/en/docs/api-automations) ([markdown](https://styrar.com/en/docs/api-automations.md))
  - Automations, approval flows, and post approval actions.
- [Sites (beta)](https://styrar.com/en/docs/sites) ([markdown](https://styrar.com/en/docs/sites.md))
  - Beta: multi-page websites on styrar.site, how they differ from bio, and how API permissions work.
- [Theme packages (beta)](https://styrar.com/en/docs/sites-theme-packages) ([markdown](https://styrar.com/en/docs/sites-theme-packages.md))
  - Beta: package JSON structure, theme tokens and CSS variables, customCss, catalog, and install modes.
- [OAuth integration](https://styrar.com/en/docs/oauth-integration) ([markdown](https://styrar.com/en/docs/oauth-integration.md))
  - Build third-party apps with user consent and scoped access tokens.