Help Center

Menu

Bynder

Squiz has established a technical partnership with Bynder, allowing for integration between Squiz products and services and Bynder’s digital asset management (DAM) platform.

This integration enables automatic media asset updates from Bynder to Squiz.

Bynder and Squiz integration also enables asset management and distribution across various channels.

Credentials

To build an integration flow, the initial step of creating an OAuth app involves the following steps:

  1. Click on Portal Settings in the top right corner of the dashboard.

  2. Select OAuth Apps From the left menu.

  3. Click the Add New App button.

  4. Complete the Required Fields:

    Application Name

    Assign a name to the app.

    Integration

    Select Others  Others as the type of integration.

    Grant Type

    Choose Authorization Code + Refresh Token.

    Authorization Redirect URI

    Set this to https://TENANT_ADDRESS/callback/oauth2, where TENANT_ADDRESS is the domain of the integration platform.

    Scopes

    Choose the required scopes, ensuring that current.user:read is selected for successful credential verification.

  5. Click the Register Application button.

  6. Save the Client ID and Client Secret as they are needed for component credentials.

    To enable this feature, you must have the Customer Success Manager role assigned in your portal.

  7. From the drop-down, select OAuth 2.0 as the authorization type. If previously created clients exist, they will be presented here as options.

  8. If no extant clients exist, click Add new Auth client.

  9. Assign a name to the new Auth client. This name can be any Unicode string up to 256 characters.

  10. Enter:

    • The client ID obtained from your Bynder app.

    • The selected OAuth 2.0 client secret.

    • The OAuth2 authorization endpoint: https://BYNDER_DOMAIN/v6/authentication/oauth2/auth.

    • The Refresh token endpoint: https://BYNDER_DOMAIN/v6/authentication/oauth2/token.

      BYNDER_DOMAIN is the domain of your Bynder installation.

  11. Assign a name to identify these credentials within the Squiz Integrations service.

  12. Specify the Scopes required to access your Bynder objects. For example;

    • current_user_read

    • asset_read

    • asset_write

    • collection_read.

      Additional parameters are optional.

  13. Enter the Bynder installation base URL.

  14. Click Authenticate.

    A sign-in screen will open.

  15. After successfully signing in, the confirmation page presents. It will list the configured integration scope of your Squiz account with the Bynder API.

Triggers

Get New and Updated Objects Polling

Retrieve all the updated or created objects within a given time range.

Configuration fields

Object Type

A required drop-down. Type of object to poll on. Currently supported only assets.

Timestamp field to poll on

An optional drop-down. Select the date field to track changes.

Emit behavior

An optional drop-down. Indicates emit objects behavior:

  • Emit individually (default)

  • Emit page.

Size of polling page

An optional, positive integer. The maximum (and default) is 100. This indicates the size of the pages to be fetched.

Start time

An optional string. The (inclusive) timestamp, in ISO8601 format, from which to start polling. The default value is the beginning of time (January 1, 1970 at 00:00.000).

Input metadata

None.

Output metadata

For Fetch page

An object with key results that has an array as its value.

For Emit Individually

Each object fills the entire message.

Actions

Delete object by ID

Delete a single object using its ID.

Configuration fields

Object Type

A required string. The type of object to delete. The supported types are:

  • User.

  • Asset.

  • Metaproperty.

  • Collection.

Input metadata

ID Value

A required string. The ID of the object to delete.

Output metadata

Returns the ID of the object that was deleted.

Lookup object by ID

Retrieve a single object using its ID.

Configuration fields

Object Type

A required string. The type of object to look up. The currently supported types are:

  • User.

  • Asset.

  • Asset content.

  • Metaproperty.

  • Collection.

Input metadata

ID Value

A required string. The ID of the object to look up.

Output metadata

Returns an object with the result of the lookup.

If the Asset content type is selected, the result will include attachmentUrl, which is a link to the file stored within the platform’s internal storage (Maester).

Known limitations

Clicking the Generate Stub Sample button may produce output metadata that is limited to the fields provided in the Bynder documentation, which does not provide a complete overview of the available API objects.

Lookup objects (plural)

Lookup a set of objects based on a defined list of criteria.

The results can be emitted in different ways.

Configuration fields

Object Type

A required drop-down. The type of object to look up. The currently supported types are:

  • User.

  • Asset.

  • Asset content.

  • Metaproperty.

  • Collection.

Emit Behavior

A required drop-down. Specifies how the resulting objects will be emitted:

  • Emit All.

  • Emit Individually.

Input metadata

A dynamically generated list of available criteria.

Output metadata

Emit All

An object with the key results containing an array as its value. In some cases, there might be additional keys with information. For example, if you use Assets as Object Type and set Include count as true, there will be additional keys.

Emit Individually

Each object fills the entire message.

Upsert object

This action either updates an existing object or creates a new one.

Configuration fields

Operation

A required drop-down. Choose the operation to perform:

  • Update.

  • Create.

Object type

A required drop-down. Select the type of object to update or create. The currently supported types are:

  • User.

  • Asset.

  • Metaproperty.

  • Collection.

Input metadata

Fields are dynamically generated based on the selected Object Type.

If the Operation is set to Update, an additional field will appear:

{Object Type} ID

A required string. The ID of the object to update.

Output metadata

The result object from the create or update operation.

Make raw request

Allows for the execution of custom requests using the Bynder REST API directly.

Configuration fields

Do not throw an error on 404 Response

An optional boolean. Configures the handling of 404 HTTP responses as non-errors. The default is false.

Input metadata

URL

A required string. The relative path of the resource which is appended to the base URL provided in the credentials.

Method

A required string. Specifies the HTTP method for the request.

Request Body

An optional object. The body content for the request.

Output metadata

Status Code

A required number. The HTTP response status code.

HTTP headers

A required object. The response’s HTTP headers.

Response Body

An optional object. The body of the HTTP response.

Use cases

When building the integration flows, Squiz and Bynder integration can be triggered in several ways:

Webhook

Bynder can send a webhook to Squiz whenever there are updates to media assets in the platform.

Scheduled task

Integration can be set up to run on a schedule, such as daily or weekly, to ensure updated assets are automatically uploaded to Squiz.

User event

User actions from the Squiz DXP can trigger the integration flow to upload assets and their metaproperty to Bynder.