| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your connection. |
The Bannerbear integrator. Designed to work with data inside the application.']module[/tooltip]s allow you to monitor, create, update, send, retrieve, and list the collections, images, and videos, in your Bannerbear account.
Prerequisites
-
A Banner Bear account – create an account at bannerbear.com/.
![[Note]](https://docs.boost.space/wp-content/uploads/2022/11/note.png) |
Note |
|---|---|
|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
To connect your Bannerbear account to Boost.space Integrator you need to obtain the API Key from your Bannerbear account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Log in to your Bannerbear account.
-
Click Projects > Select the project for which you want to establish the connection > Setting / API Key.
-
Copy the API Key to your clipboard.
-
Go to Boost.space Integrator and open the Bannerbear module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API key copied in step 3, and click Continue.
The connection has been established.
Watches for a new image.
See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.
|
|
Enter (map) a name for the webhook. |
|
|
Lists all images.
|
|
|
|
|
Set the maximum number of images Boost.space Integrator should return during one execution cycle. |
Gets an image.
|
|
|
|
|
Select or map the Image UUID whose details you want to retrieve. |
Creates an image.
|
|
. |
||||||||||||||||||||||||||
|
|
Select or map the Template UUID for the image you want to create. |
||||||||||||||||||||||||||
|
|
Add the changes you want to make to the image you want to create:
|
||||||||||||||||||||||||||
|
|
Enter (map) the webhook URL address to post the image after the rendering is completed. |
||||||||||||||||||||||||||
|
|
Select whether you want to keep the transparent background for the image. |
||||||||||||||||||||||||||
|
|
Enter (map) the metadata for the image. For example, the ID of a record in your DB. |
See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.
Watch for a new video template.
|
|
Enter (map) a name for the webhook. |
|
|
Watches for a new video that is pending approval or completion.
|
|
Enter (map) a name for the webhook. |
|
|
Lists all videos.
|
|
|
|
|
Set the maximum number of videos Boost.space Integrator should return during one execution cycle. |
|
|
Select or map the status of the video:
|
Gets a video.
|
|
|
|
|
Select or map the Video UUID whose details you want to retrieve. |
Creates a video.
|
|
|||||||||||||||||||
|
|
Select or map the Template UUID for the video you want to create. |
||||||||||||||||||
|
|
Enter (map) the URL address of the video or audio file. |
||||||||||||||||||
|
|
Add the changes you want to make to the video you want to create:
|
||||||||||||||||||
|
|
Enter (map) the webhook URL address to post the image after the rendering is completed. |
||||||||||||||||||
|
|
Enter (map) the metadata for the video. For example, the ID of a record in your DB. |
||||||||||||||||||
|
|
Enter the seconds for which you want to remove the content from the video or audio file. |
Modifies a video.
|
|
|
|
|
Select or map the Video UUID whose details you want to update. |
|
|
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. |
Approves a video.
|
|
|
|
|
Select or map the Video UUID you want to approve. |
Rejects a video.
|
|
|
|
|
Select or map the Video UUID you want to delete. |
Lists all collections.
|
|
|
|
|
Set the maximum number of collections Boost.space Integrator should return during one execution cycle. |
Gets a collection.
|
|
|
|
|
Select or map the Collection UUID whose details you want to retrieve. |
Creates a collection.
|
|
|||||||||||||||||||
|
|
Select or map the Template Set UUID for the collection you want to create. |
||||||||||||||||||
|
|
Add the changes you want to make to the collection you want to create:
|
||||||||||||||||||
|
|
Enter (map) the webhook URL address to post the image after the rendering is completed. |
||||||||||||||||||
|
|
Enter (map) the metadata for the video. For example, the ID of a record in your DB. |
Watches for a new template.
See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.
|
|
Enter (map) a name for the webhook. |
|
|
Establish a connection to your Bannerbear account. |
Performs an arbitrary authorized API call.
|
|
Establish a connection to your Bannerbear account. |
|||
|
|
Enter a path relative to
|
|||
|
|
Select the HTTP method you want to use:
to retrieve information for an entry.
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
to delete an entry. |
|||
|
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
|
|
Enter the request query string. |
|||
|
|
Enter the body content for your API call. |
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:
Creates an animated gif.
|
|
|||||||||||||||||||||||||||
|
|
Select or map the Template UUID for the gif you want to create. |
||||||||||||||||||||||||||
|
|
Add the frames you want to make to the gif you want to create:
|
||||||||||||||||||||||||||
|
|
Select or map the frame per second value. |
||||||||||||||||||||||||||
|
|
Enter (map) a value for the frame duration. |
||||||||||||||||||||||||||
|
|
Enter (map) the frame per second for the gif. |
||||||||||||||||||||||||||
|
|
Select whether the gif is looped. |
||||||||||||||||||||||||||
|
|
Enter (map) the webhook URL address to post the image after the rendering is completed. |
||||||||||||||||||||||||||
|
|
Select whether you want to keep the transparent background for the image. |
||||||||||||||||||||||||||
|
|
Enter (map) the metadata for the image. For example, the ID of a record in your DB. |
Gets a collection of fonts.
-
Open any Watch module, establish a connection, click Save, and copy the URL address to your clipboard.
-
Log in to your Bannerbear account.
-
Click Projects > Open the project > Setting/API > Advanced Settings and navigate to the webhook section.
-
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.
-
Click Create Webhook.
You have successfully added the webhook. Go to Boost.space Integrator and run the scenario to receive the trigger when the specified event occurs.
Do you need help with something specific regarding Bannerbear?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch