Skip to main content

Vimeo

Vimeo is a video hosting and management platform. The Vimeo API provides programmatic access to videos, users, channels, folders (also called projects), and comments. Use this connector to ingest video and account data into Nexla, or to create and manage videos, comments, and folders on Vimeo from your Nexla flows.

Vimeo icon

Power end-to-end data operations for your Vimeo API with Nexla. Our bi-directional Vimeo connector is purpose-built for Vimeo, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Vimeo or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Vimeo workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

The Vimeo connector authenticates with OAuth 2.0. Before creating a Vimeo credential in Nexla, you need to register an API app in the Vimeo Developer portal to obtain a Client Identifier and a Client Secret. Nexla uses these values to run the OAuth 2.0 authorization-code flow, during which you sign in to Vimeo and grant Nexla access to your account.

To register a Vimeo API app and obtain your credentials:

  1. Sign in to your Vimeo account, then go to the Vimeo Developer site at developer.vimeo.com/apps.

  2. Click Create an app in the top-right corner of the page.

  3. Enter a name and a short description for your app (for example, "Nexla Integration"), agree to the API terms, and click Create app.

  4. On the app management page, locate the Client Identifier and Client Secret values. Copy both and store them securely; the Client Secret is sensitive and grants access to your app.

  5. Provide your Nexla credential's OAuth callback (redirect) URI in the app's authentication settings if Vimeo prompts for one, so the authorization flow can complete.

When you create the credential in Nexla, the connector requests the public, private, create, edit, delete, interact, and upload scopes so that source (read) and destination (write) flows both work. For full details on app registration, OAuth 2.0, and available scopes, see the Vimeo API Reference and the Vimeo Authentication guide.

Authenticate

Credentials required

FieldRequiredSecretDescription
Client IdentifierYesNoVimeo app Client Identifier, from the Vimeo Developer app registration (developer.vimeo.com/apps).
Client SecretYesYesVimeo app Client Secret, from the Vimeo Developer app registration.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Vimeo app's Client Identifier in the corresponding field. You obtained this value when you registered your Vimeo API app in Prerequisites.

  4. Enter your Vimeo app's Client Secret in the corresponding field. This value is sensitive and should be kept confidential.

  5. Complete the OAuth 2.0 authorization step by signing in to Vimeo when prompted and granting Nexla access to your account. Vimeo issues an access token that Nexla stores and refreshes for you; the token is sent in the Authorization header as a Bearer token on every request.

    If your Client Secret is ever exposed, regenerate it in the Vimeo Developer app settings and update the credential in Nexla. For details on OAuth 2.0 and scopes, see the Vimeo Authentication guide.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Vimeo connector tile, then select the credential that will be used to connect to Vimeo, and click Next; or, create a new Vimeo credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Vimeo endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Endpoints that read a single record require an ID (such as a video, user, channel, folder, or comment ID), which you can obtain from the corresponding list endpoint.

[Rest API] Get Authenticated User

Return the profile of the authenticated Vimeo user.

[Rest API] Search Users

Search for Vimeo users by query.

[Rest API] Get User

Get a single Vimeo user's profile. Requires a numeric User ID, which you can obtain from Search Users or Get Authenticated User.

[Rest API] List My Videos

List all videos uploaded by the authenticated user.

[Rest API] Get Video

Get details of a single video. Requires a numeric Video ID, which you can obtain from List My Videos or Search Videos.

[Rest API] Search Videos

Search all videos matching custom search criteria.

[Rest API] List User Videos

List videos uploaded by a specific user. Requires a numeric User ID.

[Rest API] List Channels

List all existing Vimeo channels.

[Rest API] Get Channel

Get details of a single channel. Requires a numeric Channel ID, which you can obtain from List Channels.

[Rest API] List Channel Videos

List videos published to a channel. Requires a numeric Channel ID.

[Rest API] List My Channels

List channels the authenticated user follows or owns.

[Rest API] List User Channels

List channels a specific user follows or owns. Requires a numeric User ID.

[Rest API] List My Folders

List all folders (projects) belonging to the authenticated user.

[Rest API] Get Folder

Get details of a single folder (project). Requires a numeric Folder (Project) ID, which you can obtain from List My Folders.

[Rest API] List Folder Videos

List videos contained in a folder (project). Requires a numeric Folder (Project) ID.

[Rest API] List User Folders

List folders (projects) belonging to a specific user. Requires a numeric User ID.

[Rest API] List Video Comments

List all comments on a video. Requires a numeric Video ID.

[Rest API] Get Video Comment

Get a single comment on a video. Requires a numeric Video ID and Comment ID; obtain the Comment ID from List Video Comments.

[Rest API] List Comment Replies

List all replies to a comment on a video. Requires a numeric Video ID and Comment ID.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Vimeo data sources can also be manually configured to ingest data from any valid Vimeo API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Vimeo data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Vimeo destination, and select the Send to Destination option from the menu. Select the Vimeo connector from the list of available destination connectors, then select the credential that will be used to connect to Vimeo, and click Next; or, create a new Vimeo credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Vimeo endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings. Update and delete endpoints require the numeric ID of the target record (video, comment, or folder), which the record from your Nexset must supply.

[Rest API] Upload Video

Create a video record via POST to the me/videos endpoint. For a public URL, set the upload approach to pull and provide the upload link to complete the upload in one call. Local-file uploads require a second request.

[Rest API] Update Video

Edit the metadata of an existing video. Requires a numeric Video ID.

[Rest API] Delete Video

Delete a video. Requires a numeric Video ID.

[Rest API] Create Comment

Add a comment to a video. Requires a numeric Video ID.

[Rest API] Update Comment

Edit an existing comment on a video. Requires a numeric Video ID and Comment ID.

[Rest API] Delete Comment

Delete a comment from a video. Requires a numeric Video ID and Comment ID.

[Rest API] Create Folder

Create a new folder (project) for the authenticated user.

[Rest API] Update Folder

Rename or edit an existing folder (project). Requires a numeric Folder (Project) ID.

[Rest API] Delete Folder

Delete a folder (project). Requires a numeric Folder (Project) ID.

Manual configuration

Vimeo destinations can also be manually configured to send data to any valid Vimeo API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Vimeo APIs expect JSON in the request body for create and update operations. For update and delete operations, include the numeric ID of the target record in the endpoint URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Vimeo endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Vimeo endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.