Configuration

Connect your Bynder portal

Tell the connector which Bynder portal to use. Enter the domain only, with no https:// and no trailing slash.

Option 1: appsettings.json (recommended)

appsettings.json

{
  "Bynder": {
    "LicenseAPIKey": "your-license-api-key",
    "PortalDomain": "yourcompany.getbynder.com"
  }
}

A value set in appsettings.json always wins. Changing it means a redeploy.

Option 2: the backoffice

If PortalDomain isn't in appsettings.json, an administrator can set it under Settings > Bynder > Configuration. The value is saved in the Umbraco database, so you don't need to redeploy. Once you add PortalDomain to appsettings.json, the dashboard shows that value as read-only.

How authentication works. For browsing and picking assets, the connector doesn't use a shared API account. Editors log in to Bynder with their own credentials inside the Universal Compact View the first time they open a picker. The connector only calls Bynder's API itself for the optional features, using a separate OAuth app.

Create Bynder Data Types

The connector adds two property editors. Go to Settings > Data Types > Create and choose the one that fits:

Property editor	Use it when
Bynder Asset Picker	Editors pick one or more Bynder assets, and the site renders them through a named output (derivative). This fits most image, video and document fields. With multiple picks on, editors select several assets in one Bynder session.
Bynder File Picker	Editors need to pick a specific omnichannel output (for example a channel-specific crop or format), not only the asset. Each pick is one asset at a time.

Data Type settings

Both editors share these settings:

Setting	What it does
Pick multiple items / Amount	Allow more than one pick, with an optional minimum and maximum.
Allowed Bynder asset types	Limit the picker to `IMAGE`, `DOCUMENT`, `VIDEO` and/or `AUDIO`.
Default image output / Default video output	The Bynder derivative used when the site renders the asset.
Default search term	A search term that's already filled in when the picker opens.
Predefined search tags	Only show assets that have these Bynder tags.
Predefined collection ID	Open the picker on one Bynder collection.
Predefined metaproperty filter (advanced)	Filter results by Bynder metaproperty options.
Show Bynder indicator / Show file extension	What the picked-item card shows in the backoffice.
Fallback Media Picker Data Type	Let editors pick a regular Umbraco Media item instead of a Bynder asset. Templates handle both in the same way. This helps when you move to Bynder step by step.
Fallback is main	Make the Umbraco Media option the default choice.

Then add a property that uses the new Data Type to a Document Type. Editors will see a Choose button. The first time an editor opens it, they're asked to log in to Bynder.

Enable Bynder in the rich text editor

Open your rich text editor Data Type.
Go to Capabilities > Embeds and media and turn on Bynder. It's off by default, like every capability.
Add the Bynder button to the toolbar.

Editors can embed images and documents. Both are enabled by default. To allow only one of them, set it for the whole install (it's not a per-Data-Type setting):

appsettings.json

{
  "Bynder": {
    "RTEAssetTypes": ["IMAGE"]
  }
}

⚠️

A DOCUMENT embed is a link to the original file. That asset must be marked Public in Bynder, or anonymous visitors get a Bynder login page instead of the file.
Video and audio can't be embedded in rich text. Use the Bynder Asset Picker or File Picker for video and audio.

Universal Compact View defaults

You can set defaults for Bynder's Universal Compact View for every picker under Bynder:UniversalCompactView. Each field is locked on its own. If you leave a field out, administrators can still change it under Settings > Bynder > Configuration.

appsettings.json

{
  "Bynder": {
    "UniversalCompactView": {
      "Language": "backoffice",
      "HideSwitch": false,
      "IsPersonal": false,
      "ShowFilterToolbar": true
    }
  }
}

Language can be backoffice (follow each editor's backoffice language) or one of en_US, nl_NL, de_DE, fr_FR or es_ES.

Full appsettings.json reference

appsettings.json

{
  "Bynder": {
    "LicenseAPIKey": "your-license-api-key",
    "PortalDomain": "yourcompany.getbynder.com",
    "RTEAssetTypes": ["IMAGE", "DOCUMENT"],
    "UniversalCompactView": {
      "Language": "backoffice"
    },
    "OAuth": {
      "ClientId": "your-client-id",
      "ClientSecret": "set-via-environment-variable",
      "AssetTrackingEnabled": true,
      "MetaDataSyncEnabled": false,
      "TranscriptSyncEnabled": false
    },
    "MetaDataFieldMapping": {
      "Image": { "Fields": { "altText": "Description", "copyright": "Copyright" } }
    }
  }
}

Only LicenseAPIKey and PortalDomain are required, and you can set both from the backoffice instead. Everything else is optional. The OAuth and MetaDataFieldMapping sections are explained in Optional Features.

Installation Optional Features