• Documentation >
• Apps >
• File and Document Management >
• Bannerbear

Bannerbear

The Bannerbear modules allow you to monitor, create, update, send, retrieve, and list the collections, images, and videos, in your Bannerbear account.

Getting Started with Bannerbear

Prerequisites

• A Banner Bear account - create an account at bannerbear.com/.

Note

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

Connecting Bannerbear to Ibexa Connect

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

1. Log in to your Bannerbear account.

2. Click Projects > Select the project for which you want to establish the connection > Setting / API Key.

   

3. Copy the API Key to your clipboard.

   

4. Go to Ibexa Connect 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 copied in step 3, and click Continue.

The connection has been established.

Image

Watch New Image

Watches for a new image.

See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.

Webhook Name	Enter (map) a name for the webhook.

List Images

Lists all images.

Limit	Set the maximum number of images Ibexa Connect should return during one execution cycle.

Get an Image

Gets an image.

Image UUID	Select or map the Image UUID whose details you want to retrieve.

Create an Image

Creates an image.

Connection	.
Template UUID	Select or map the Template UUID for the image you want to create.
Modifications	Add the changes you want to make to the image you want to create: Name Enter (map) a name for the image. Text Enter (map) the text you want to mention about the image. Color Enter (map) the color of the image object. For example, #FF0000. Background Enter (map) the color of the image background. For example, #FF0000. Font Type Select or map the font type of the image text. Anchor X Select or map the shift layer along the x-axis. For example, left. Anchor Y Select or map the shift layer along the y-axis. For example, left. Fill Type Select or map the image color fill type. For example, fill. Image URL Enter (map) the URL address of the image URL address you want to create. Chart Data Enter (map) a comma-delimited list of numbers to send to a Bar Chart object. Rating Enter (map) a number from 0 to 100 to send to a Star Rating object. Target Enter (map) the URL address or text to send to a QR Code object. Hide Select whether you want to hide the object.
Webhook URL	Enter (map) the webhook URL address to post the image after the rendering is completed.
Transparent	Select whether you want to keep the transparent background for the image.
Metadata	Enter (map) the metadata for the image. For example, the ID of a record in your DB.

Video

See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.

Watch New Video Template

Watch for a new video template.

Webhook Name	Enter (map) a name for the webhook.

Watch New Video Pending Approval or Completed

Watches for a new video that is pending approval or completion.

Webhook Name	Enter (map) a name for the webhook.

List Videos

Lists all videos.

Limit	Set the maximum number of videos Ibexa Connect should return during one execution cycle.
Status	Select or map the status of the video: Completed Pending Approval

Get a Video

Gets a video.

Video UUID	Select or map the Video UUID whose details you want to retrieve.

Create a Video

Creates a video.

Video Template UUID	Select or map the Template UUID for the video you want to create.
Input Media URL	Enter (map) the URL address of the video or audio file.
Modifications	Add the changes you want to make to the video you want to create: Name Enter (map) a name for the video. Text Enter (map) the text you want to mention about the video. Color Enter (map) the color of the video object. For example, #FF0000. Background Enter (map) the color of the video object background. For example, #FF0000. Image URL Enter (map) the URL address of the video URL address you want to create. Chart Data Enter (map) a comma-delimited list of numbers to send to a Bar Chart object. Rating Enter (map) a number from 0 to 100 to send to a Star Rating object. Target Enter (map) the URL address or text to send to a QR Code object. Hide Select whether you want to hide the object.
Webhook URL	Enter (map) the webhook URL address to post the image after the rendering is completed.
Metadata	Enter (map) the metadata for the video. For example, the ID of a record in your DB.
Trim to Length in Seconds	Enter the seconds for which you want to remove the content from the video or audio file.

Update a Video

Modifies a video.

Video UUID

Select or map the Video UUID whose details you want to update.

Transcription

Add the transcriptions for the video which you want to update.An array of strings of your new transcription. Please Note: Each element of the transcription array represents a specific timestamp. For that reason, 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.

Video UUID	Select or map the Video UUID you want to approve.

Delete a Video

Rejects a video.

Video UUID	Select or map the Video UUID you want to delete.

Collection

List Collections

Lists all collections.

Limit	Set the maximum number of collections Ibexa Connect should return during one execution cycle.

Get a Collection

Gets a collection.

Collection UUID	Select or map the Collection UUID whose details you want to retrieve.

Create a Collection

Creates a collection.

Template Set UUID	Select or map the Template Set UUID for the collection you want to create.
Modifications	Add the changes you want to make to the collection you want to create: Name Enter (map) a name for the collection. Text Enter (map) the text you want to mention about the collection. Color Enter (map) the color of the object. For example, #FF0000. Background Enter (map) the color of the collection background. For example, #FF0000. Image URL Enter (map) the URL address of the image URL address you want to create. Chart Data Enter (map) a comma-delimited list of numbers to send to a Bar Chart object. Rating Enter (map) a number from 0 to 100 to send to a Star Rating object. Target Enter (map) the URL address or text to send to a QR Code object. Hide Select whether you want to hide the object.
Webhook URL	Enter (map) the webhook URL address to post the image after the rendering is completed.
Metadata	Enter (map) the metadata for the video. For example, the ID of a record in your DB.

Other

Watch New Template

Watches for a new template.

See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.

Webhook Name	Enter (map) a name for the webhook.

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.bannerbear.com For example: /v1/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:

/v1/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:

Create an Animated Gif

Creates an animated gif.

Template UUID	Select or map the Template UUID for the gif you want to create.
Frames	Add the frames you want to make to the gif you want to create: Name Enter (map) a name for the gif. Text Enter (map) the text you want to mention about the gif. Color Enter (map) the color of the gif object. For example, #FF0000. Background Enter (map) the color of the gif background. For example, #FF0000. Font Type Select or map the font type of the image text. Anchor X Select or map the shift layer along the x-axis. For example, left. Anchor Y Select or map the shift layer along the y-axis. For example, left. Fill Type Select or map the image color fill type. For example, fill. Image URL Enter (map) the URL address of the image URL address you want to create. Chart Data Enter (map) a comma-delimited list of numbers to send to a Bar Chart object. Rating Enter (map) a number from 0 to 100 to send to a Star Rating object. Target Enter (map) the URL address or text to send to a QR Code object. Hide Select whether you want to hide the object.
Set FPS Value	Select or map the frame per second value.
Fram Duration	Enter (map) a value for the frame duration.
FPS	Enter (map) the frame per second for the gif.
Loop	Select whether the gif is looped.
Webhook URL	Enter (map) the webhook URL address to post the image after the rendering is completed.
Transparent	Select whether you want to keep the transparent background for the image.
Metadata	Enter (map) the metadata for the image. For example, the ID of a record in your DB.

Uncategorized

Get Fonts Collection

Gets a collection of fonts.

Setting Up Bannerbear Webhooks

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

   

2. Log in to your Bannerbear account.

3. Click Projects > Open the project > Setting/API > Advanced Settings and navigate to the webhook section.

4. In the Endpoint URL field, enter the URL address copied in step 1 and select the event for which you want to receive the alerts.

5. Click Create Webhook.

   

You have successfully added the webhook. Go to Ibexa Connect and run the scenario to receive the trigger when the specified event occurs.