Articles in this section

Bannerbear

Integromat Updated January 17, 2021 20:06

The Bannerbear modules allow you to watch, create, list, retrieve, and delete the images, videos, and collections in your Bannerbear account.

Getting Started with Bannerbear

Prerequisites

A Bannerbear account

In order to use Bannerbear with Integromat, it is necessary to have a Bannerbear account. If you do not have one, you can create a Bannerbear account at app.bannerbear.com.

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting Bannerbear to Integromat

To connect your Bannerbear account to Integromat you need to obtain the API Key from your Bannerbear account and insert it in the Create a connection dialog in the Integromat module.

1. Log in to your Bannerbear account and open your Dashboard.

2. Select the project for which you want to establish the connection and click Settings / API Key.

3. Copy the Project API Key to your clipboard.

4. Go to Integromat and open the Bannerbear module's Create a connection dialog.

5. In the Connection name field, enter a name for the connection.

6. In the API Key field, enter the API key details copied in step 3, and click Continue.

The connection has been established.

Image

Watch New Image

Watches for a new image.

Webhook Name	Enter a name for the webhook.
Connection	Establish a connection to your Bannerbear account.

See the Connecting to Bannerbear Webhook Using Integromat to add the webhook in your Bannerbear account.

List Image

Lists all images.

Connection	Establish a connection to your Bannerbear account.
Limit	Set the maximum number of images Integromat should return during one scenario execution cycle.

Get an Image

Gets an image.

Connection	Establish a connection to your Bannerbear account.
Image UID	Select the Image UID whose details you want to retrieve.

Create an Image

Creates an image.

Connection Establish a connection to your Bannerbear account.

Template UUID Select the Template UID for the image you want to create.

Modifications

Add modifications for the image:

Name	Enter a name for the image.
Text	Enter the text which appears on the image.
Color	Enter the color you want to provide for the image. For example, `#FF0000` for red.
Background	Enter the background color for the image. For example, `#FF0000` for red.
Image URL	Enter the URL address to the image.
Chart Data	Enter a list of numbers to send to a Bar Chart object separated by a comma.
Rating	Enter the image rating number between 0 to 1000.
Target	Enter a URL address or text to send to a QR Code object.
Hide	Select whether you want to hide the image.

Webhook URL Enter the URL address to POST the Image object to upon rendering completed.

Transparent Select whether you want to render a PNG with a transparent background. By default, the image will have a white background.

Metadata Enter the metadata that you want to store. For example, the ID of a record in your DB.

Video

Watch New Video Templates

Watches for a new video template.

Connection	Establish a connection to your Bannerbear account.
Limit	Set the maximum number of video templates Integromat should return during one scenario execution cycle.

Watch New Video Pending or Complete

Watches or a new video that is pending approval or completed.

Webhook Name	Enter a name for the webhook.
Connection	Establish a connection to your Bannerbear account.

See the Connecting to Bannerbear Webhook Using Integromat to add the webhook in your Bannerbear account.

List Videos

Lists all videos.

Connection	Establish a connection to your Bannerbear account.
Limit	Set the maximum number of videos Integromat should return during one scenario execution cycle.
Status	Select the status of the videos you want to list: Completed Pending Approval

Get a Video

Gets a video.

Connection	Establish a connection to your Bannerbear account.
Video UID	Select the Video UID whose details you want to retrieve.

Create a Video

Creates a video.

Connection Establish a connection to your Bannerbear account.

Video Template UID Select the Template UID for the video you want to create.

Input Media URL Enter the full URL address to a video or audio file you want to import as the background of the video.

Modifications

Add modifications for the image:

Name	Enter a name for the video.
Text	Enter the text which appears on the video.
Color	Enter the color you want to provide for the video. For example, `#FF0000` for red.
Background	Enter the background color for the video. For example, `#FF0000` for red.
Image URL	Enter the URL address to the video.
Chart Data	Enter a list of numbers to send to a Bar Chart object separated by a comma.
Rating	Enter the video rating number between 0 to 1000.
Target	Enter a URL address or text to send to a QR Code object.
Hide	Select whether you want to hide the video.

Webhook URL Enter the URL address to POST the video object upon rendering is completed.

Metadata Enter the metadata that you need to store. For example, the ID of a record in your DB.

Trim to Length in Seconds Enter the length of the time in seconds that you want to trim from the video.

Update a Video

Modifies a video.

Connection	Establish a connection to your Bannerbear account.
Video UID	Select the Video UID whose details you want to update.
Transcription	Add the transcription details you want to edit. An array of strings of your new transcription. Each element of the transcription array represents a specific timestamp. So the number of lines of your patched text must match the original. Bannerbear will not update the record if the number is different. Editing transcriptions are meant for minor corrections, not making major changes.

Approve a Video

Approves a video.

Connection	Establish a connection to your Bannerbear account.
Video UID	Select the Video UID you want to approve.

Delete a Video

Rejects a video.

Connection	Establish a connection to your Bannerbear account.
Video UID	Select the Video UID you want to reject or delete.

Collection

List Collections

Lists all collections.

Connection	Establish a connection to your Bannerbear account.
Limit	Set the maximum number of collections Integromat should return during one scenario execution cycle.

Get a Collection

Gets a collection.

Connection	Establish a connection to your Bannerbear account.
Collection UID	Select the Collection UID whose details you want to retrieve.

Create a Collection

Creates a collection.

Connection Establish a connection to your Bannerbear account.

Video Template UID Select the Template UID for the collection you want to create.

Modifications

Add modifications for the image:

Name	Enter a name for the collection.
Text	Enter the text which appears on the collection.
Color	Enter the color you want to provide for the collection. For example, `#FF0000` for red.
Background	Enter the background color for the collection. For example, `#FF0000` for red.
Image URL	Enter the URL address to the collection.
Chart Data	Enter a list of numbers to send to a Bar Chart object separated by a comma.
Rating	Enter the video rating number between 0 to 1000.
Target	Enter a URL address or text to send to a QR Code object.
Hide	Select whether you want to hide the collection.

Webhook URL Enter the URL address to POST the collection object upon the rendering is completed.

Other

Watch New Template

Watches for a new template.

Connection	Establish a connection to your Bannerbear account.
Limit	Set the maximum number of new templates Integromat should return during one scenario execution cycle.

Make an API Call

Performs an arbitrary authorized API call.

Connection	Establish a connection to your Bannerbear account.
URL	Enter a path relative to `https://api.bannerbear.com/`. For example: `/v2/collections` For the list of available endpoints, refer to the Bannerbear API Documentation.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - List Images

The following API call returns all the images from your Bannerbear account:

URL:
/v2/images

Method:
GET

Matches of the search can be found in the module's Output under Bundle > Body.
In our example, 3 images were returned:

Connecting to Bannerbear Webhook Using Integromat

1. Open any Watch module, establish a connection, click Save, and copy the URL address to your clipboard. Click OK and save the trigger.

2. Log in to your Bannerbear account. Select the project for which you want to add the webhook, and click Settings / API Key > Advanced Settings.

3. In the Create a Webhook section, enter the URL address copied in step 1, select the events for which you want to receive the triggers, and click Create a Webhook.

You have added the webhook successfully.

Was this article helpful?

0 out of 1 found this helpful