# Host Videos on Vimeo

[Vimeo](https://www.vimeo.com), a cloud-based video hosting platform, allows you to host and share your videos.

This integration allows you to effortlessly upload your videos to Vimeo.

### Setup

To send your videos directly to your Vimeo account you will have to connect Shotstack to your Vimeo Account. This will
provide Shotstack with permissions to upload videos to Vimeo on your behalf.

Login to the dashboard and navigate to the [integrations](https://dashboard.shotstack.io/integrations) page, find the
Vimeo destination and click [configure](https://dashboard.shotstack.io/integrations/vimeo).

Click the **Connect to Vimeo** button and follow the prompts.

![Vimeo Credentials](/img/vimeo-credentials.png)

### Integration

#### Basic integration

To send files to Vimeo add the following to the output parameter of the render payload:

```json
"destinations": [{
    "provider": "vimeo"
}]
```

The following will set a name and description for your video and send the rendered videos to your Vimeo account:

```json
"destinations": [{
    "provider": "vimeo",
    "options": {
        "name": "My Automated Video",
        "description": "This video was uploaded via Shotstack"
    }
}]
```

#### Set folder

Shotstack allows you to send videos to a folder inside Vimeo:

```json
"destinations": [{
    "provider": "vimeo",
    "options": {
        "name": "My Automated Video",
        "description": "This video was uploaded via Shotstack",
        "folderUri": "/users/{user_id}/folders/{project_id}"
    }
}]
```

:::info Info

Review the [Vimeo documentation](https://developer.vimeo.com/api/guides/folders) for more information on how to manage folders.

:::

#### Setting video privacy

Shotstack allows you to set the privacy settings of your videos:

```json
"destinations": [{
    "provider": "vimeo",
    "options": {
        "name": "My Automated Video",
        "description": "This video was uploaded via Shotstack",
        "privacy": {
            "view": "anybody",
            "embed": "public",
            "comments": "anybody",
            "download": true,
            "add": false
        }
    }
}]
```

The available options are:

| Option | Type | Values |
| :--- | :--- | :--- |
| `view` | string | `anybody`, `nobody`, `contacts`, `password`, `unlisted` |
| `embed` | string | `public`, `private`, `whitelist` |
| `comments` | string | `anybody`, `nobody`, `contacts` |
| `download` | boolean | Set whether the video can be downloaded. |
| `add` | boolean | Set whether other users can add the video to their collections. |

### Opting out from the Shotstack destination

By default all generated files are sent to the Shotstack destination. If you are using Vimeo you may wish to [opt
out](../self-host.md) from hosting your videos with Shotstack using:

```json
"destinations": [{
    "provider": "vimeo",
    "options": {
        "folderId": "2t-eTY12LO8tzQLAwMug-fIrK_7AQBI6B"
    }
},{
    "provider": "shotstack",
    "exclude": true
}]
```

This will send the generated video to Vimeo but not to Shotstack.