> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Wistia

> How to set up the Wistia connector, plus the actions and events that are available.

![Wistia](https://stackone-logos.com/api/wistia/filled/svg)

v2.0.3[See changelog](https://docs.stackone.com/connectors/wistia/changelog.md)

[63 actions](#actions) · [19 events](#events) · 2 auth methods

Media

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/wistia/guides/connector-profile/oauth-2-0.md)
>
> Connect your Wistia account securely using OAuth 2.0 authorization for multi-user access and enhanced security.

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/wistia/guides/connector-profile/api-token.md)
>
> Use an API Token for quick authentication. Best suited for testing, development, or single-account integrations.

Optionally, configure receiving Events for Wistia into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/wistia/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/wistia/guides/link-account/oauth-2-0.md)

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/wistia/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

all:all

all:read

media:read

media:upload

stats:read

No scopes found

63 actions

ActionDescriptionRequired scopes

Get Account`wistia_get_account`

Retrieves a summary of the Wistia account

`all:read`

List Media`wistia_list_medias`

Lists the media belonging to the account

`media:read`

Show Media`wistia_get_media`

Fetches a single media by its hashed id

`media:read`

Update Media`wistia_update_media`

Updates the attributes on a media

`all:all`

Delete Media`wistia_delete_media`

Deletes a media

`all:all`

Copy Media`wistia_copy_media`

Copies a media and its assets to a destination folder

`all:all`

Show Media Aggregated Stats`wistia_get_media_stats`

Aggregated tracking statistics for a video embedded on your site

`stats:read`

Archive Media`wistia_archive_medias`

Archives up to 100 medias per request asynchronously

`all:all`

Restore Media`wistia_restore_medias`

Restores archived medias to your account

`all:all`

Move Media`wistia_move_medias`

Move one or many media to a different folder and optionally to a specific subfolder

`all:all`

Translate Media`wistia_translate_media`

Translates the transcript for a media

`all:all`

Import Media From URL`wistia_upload_media`

Imports a media file into Wistia from a publicly accessible web URL, supporting video, audio, image, PDF, and document f...

`media:upload`

Show Customizations`wistia_get_customizations`

Retrieves the explicitly defined video player customizations for a specific media, including player color, controls visi...

`media:read`

Update Customizations`wistia_update_customizations`

Partially updates video player customizations for a specific media, including player color, controls, autoplay, captions...

`all:all`

Swap Media`wistia_swap_media`

Replaces one media's content with another while preserving the original media's hashed ID, embed codes, and URLs. Queues...

`all:all`

Show Media Analytics`wistia_get_media_analytics`

Retrieves aggregate analytics for a video over a date range, including plays, loads, engagement rate, play rate, visitor...

`stats:read`

Delete Customizations`wistia_delete_customizations`

Deletes all explicit video player customizations for a media, resetting it to default appearance and behavior as if it w\...

`all:all`

List Folders`wistia_list_folders`

Lists folders (previously called projects) belonging to the account

`media:read`

Show Folder`wistia_get_folder`

Retrieves a single folder (previously called project)

`media:read`

Create Folder`wistia_create_folder`

Creates a new folder (previously called project)

`all:all`

Update Folder`wistia_update_folder`

Updates a folder (previously called project)

`all:all`

Delete Folder`wistia_delete_folder`

Deletes a folder (previously called project)

`all:all`

Copy Folder`wistia_copy_folder`

Copies a folder (previously called project) and all its media and subfolders asynchronously

`all:all`

List Subfolders`wistia_list_subfolders`

Lists subfolders in a specific folder

`media:read`

Show Subfolder`wistia_get_subfolder`

Retrieves detailed information about a specific subfolder

`media:read`

Create Subfolder`wistia_create_subfolder`

Creates a new subfolder within a folder

`all:all`

Update Subfolder`wistia_update_subfolder`

Updates a subfolder's name and/or description

`all:all`

Delete Subfolder`wistia_delete_subfolder`

Deletes a subfolder from a folder

`all:all`

Bulk Delete Subfolders`wistia_bulk_delete_subfolders`

Deletes multiple subfolders asynchronously

`all:all`

List Folder Sharings`wistia_list_sharings`

Lists the sharings of contacts and contact groups on a folder, including each contact's permissions (admin, share, downl...

`all:read`

List Tags`wistia_list_tags`

Lists tags belonging to the account

`media:read`

Create Tag`wistia_create_tag`

Creates a new tag

`all:all`

Delete Tag`wistia_delete_tag`

Deletes a tag

`all:all`

List Captions`wistia_list_all_captions`

Lists captions belonging to the account

`media:read`

List Captions By Media`wistia_list_media_captions`

Lists captions belonging to a specific video

`media:read`

Show Captions`wistia_get_caption`

Returns a video's captions in the specified language

`media:read`

Create Captions`wistia_create_caption`

Adds captions to a specified video

`all:all`

Update Captions`wistia_update_caption`

Replaces the captions on a video for the specified language

`all:all`

Delete Captions`wistia_delete_caption`

Removes the captions file from a video for the specified language

`all:all`

Purchase Captions`wistia_purchase_captions`

Purchases English captions for a video

`all:all`

List Channels`wistia_list_channels`

Lists all Channels belonging to an account

`media:read`

Show Channel`wistia_get_channel`

Returns the Channel associated with the hashedId

`media:read`

Create Channel`wistia_create_channel`

Create a new channel

`all:all`

Update Channel`wistia_update_channel`

Update a channel

`all:all`

Delete Channel`wistia_delete_channel`

Delete endpoint for a channel

`all:all`

List Channel Episodes`wistia_list_all_episodes`

Lists Channel Episodes belonging to an account

`media:read`

List Channel Episodes By Channel`wistia_list_channel_episodes`

Lists Channel Episodes belonging to the channel passed in the path

`media:read`

Create Channel Episode`wistia_create_channel_episode`

Creates a new channel episode in a channel

`all:all`

Channel Episode Update`wistia_update_channel_episode`

Updates an existing channel episode in a channel

`all:all`

Channel Episode Delete`wistia_delete_channel_episode`

Deletes an existing channel episode in a channel

`all:all`

Publish Channel Episode`wistia_publish_channel_episode`

Publishes an existing channel episode in a channel

`all:all`

Unpublish Channel Episode`wistia_unpublish_channel_episode`

Unpublishes an existing channel episode in a channel

`all:all`

List Webinars`wistia_list_webinars`

Lists webinars belonging to the account

`all:read`

Show Webinar`wistia_get_webinar`

Returns the webinar associated with the hashed id

`all:read`

Create Webinar`wistia_create_webinar`

Creates a new webinar

`all:all`

Update Webinar`wistia_update_webinar`

Updates an existing webinar

`all:all`

Delete Webinar`wistia_delete_webinar`

Deletes an existing webinar

`all:all`

Create Webinar Registration`wistia_create_webinar_registration`

Register a person for a webinar by providing their email, first name, and last name

`all:all`

List Allowed Domains`wistia_list_allowed_domains`

Lists allowed domains belonging to the account

`all:read`

Show Allowed Domain`wistia_get_allowed_domain`

Returns the details of an allowed domain

`all:read`

Create Allowed Domain`wistia_create_allowed_domain`

Creates an allowed domain for the account

`all:all`

Delete Allowed Domain`wistia_delete_allowed_domain`

Deletes an allowed domain from the account

`all:all`

Create Expiring Access Token`wistia_create_expiring_token`

Creates expiring access tokens which can be used for some iframe embeds

`all:all`

## Events

Tags

Select all
|
Clear

Captions

Live Events

Localizations

Medias

Viewing Sessions

Webhooks

No tags found

19 events

EventDescriptionTags

Media Created`wistia_webhook_media_created`

Emitted when a new media (video, audio, image, PDF, etc.) is created in a Wistia account. Maps to Wistia event \`media.cr...

MediasWebhooks

Media Processing`wistia_webhook_media_processing`

Emitted when a media begins processing (encoding) after upload. Maps to Wistia event `media.processing`.

MediasWebhooks

Media Ready`wistia_webhook_media_ready`

Emitted when a media finishes processing and is ready for viewing/embedding. Maps to Wistia event `media.ready`.

MediasWebhooks

Media Processing Failed`wistia_webhook_media_failed`

Emitted when a media fails to process (encode). Maps to Wistia event `media.failed`.

MediasWebhooks

Media Updated`wistia_webhook_media_updated`

Emitted when a media's metadata (name, description, customizations, etc.) is updated. Maps to Wistia event \`media.update...

MediasWebhooks

Media Transcript Updated`wistia_webhook_media_transcript_updated`

Emitted when a media's transcript/caption text is updated. Maps to Wistia event `media.transcript_updated`.

MediasCaptionsWebhooks

Media Transcript Failed`wistia_webhook_media_transcript_failed`

Emitted when generating a media's transcript/caption fails. Maps to Wistia event `media.transcript_failed`.

MediasCaptionsWebhooks

Media Deleted`wistia_webhook_media_deleted`

Emitted when a media is deleted from a Wistia account. Maps to Wistia event `media.deleted`.

MediasWebhooks

Media Translation Created`wistia_webhook_media_translation_created`

Emitted when a translated transcript is created for a media. Maps to Wistia event `media.translation_created`. Payload i...

MediasCaptionsWebhooks

Media Localization Created`wistia_webhook_media_localization_created`

Emitted when a localized (dubbed/subtitled) version of a media is created. Maps to Wistia event \`media.localization\_crea...

MediasLocalizationsWebhooks

Media Localization Failed`wistia_webhook_media_localization_failed`

Emitted when creating a localized (dubbed/subtitled) version of a media fails. Maps to Wistia event \`media.localization\_...

MediasLocalizationsWebhooks

Viewing Session Play`wistia_webhook_viewing_session_play`

Emitted when a visitor presses play on a video for the first time in a viewing session, or the video autoplays. Maps to...

Viewing SessionsWebhooks

Viewing Session Percent Watched`wistia_webhook_viewing_session_percent_watched`

Emitted as a visitor crosses percent-watched thresholds (e.g. 25%, 50%, 75%, 100%) of a video during a viewing session....

Viewing SessionsWebhooks

Viewing Session Turnstile Converted`wistia_webhook_viewing_session_turnstile_converted`

Emitted when a visitor submits a turnstile (email-gate) form during a viewing session. Maps to Wistia event \`viewing\_ses...

Viewing SessionsWebhooks

Viewing Session Call To Action Converted`wistia_webhook_viewing_session_call_to_action_converted`

Emitted when a visitor clicks/converts on an in-video call-to-action during a viewing session. Maps to Wistia event \`vie...

Viewing SessionsWebhooks

Viewing Session Annotation Converted`wistia_webhook_viewing_session_annotation_converted`

Emitted when a visitor clicks/converts on an in-video annotation link during a viewing session. Maps to Wistia event \`vi...

Viewing SessionsWebhooks

Live Event Registration`wistia_webhook_live_event_registration`

Emitted when a visitor registers for a Wistia Live Event (webinar). Maps to Wistia event `live_event.registration`.

Live EventsWebhooks

Live Event Started`wistia_webhook_live_event_started`

Emitted when a Wistia Live Event (webinar) starts. Maps to Wistia event `live_event.started` (event-type string unverifi...

Live EventsWebhooks

Live Event Ended`wistia_webhook_live_event_ended`

Emitted when a Wistia Live Event (webinar) ends. Maps to Wistia event `live_event.ended` (event-type string unverified —...

Live EventsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.