Active with remarks |
---|
This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
The Bannerbear modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. 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 | |
---|---|
The modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. dialog fields that are displayed in bold (in the Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., 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 webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. in your Bannerbear account.
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. Name |
Enter (map) a name for the webhook. |
Connection |
Lists all images.
Connection |
|
Limit |
Set the maximum number of images Boost.space Integrator should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Gets an image.
Connection |
|
Image UUID |
Select or map the Image UUID whose details you want to retrieve. |
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:
|
||||||||||||||||||||||||||
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 recordIn Boost.space, a record is a single data entry within a module, like a row in a database. For example, a contact in the Contacts module or a task in the Tasks module. in your DB. |
See the Setting Up Bannerbear Webhooks for adding the webhooks in your Bannerbear account.
Watch for a new video template.
Webhook Name |
Enter (map) a name for the webhook. |
Connection |
Watches for a new video that is pending approval or completion.
Webhook Name |
Enter (map) a name for the webhook. |
Connection |
Lists all videos.
Connection |
|
Limit |
Set the maximum number of videos Boost.space Integrator should return during one execution cycle. |
StatusIn Boost.space, statuses are indicators assigned to records within modules to represent their current state or progress. They can be system-defined, such as "Active" or "Done," or custom-created to fit specific workflows. Statuses help track and manage tasks, projects, and processes efficiently. |
Select or map the status of the video:
|
Gets a video.
Connection |
|
Video UUID |
Select or map the Video UUID whose details you want to retrieve. |
Creates a video.
Connection |
|||||||||||||||||||
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:
|
||||||||||||||||||
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. |
Modifies a video.
Connection |
|
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 arrayWithin a bundle, data items of the same type are sometimes in an array. You can find an array by looking at the details of a bundle. Depending on the details of your scenario, you can map other modules to a specific item in an array or use iterators and aggregators to manipulate your data into other formats. When mapping,... 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.
Connection |
|
Video UUID |
Select or map the Video UUID you want to approve. |
Rejects a video.
Connection |
|
Video UUID |
Select or map the Video UUID you want to delete. |
Lists all collections.
Connection |
|
Limit |
Set the maximum number of collections Boost.space Integrator should return during one execution cycle. |
Gets a collection.
Connection |
|
Collection UUID |
Select or map the Collection UUID whose details you want to retrieve. |
Creates a collection.
Connection |
|||||||||||||||||||
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:
|
||||||||||||||||||
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. |
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. |
Connection |
Performs an arbitrary authorized API call.
Connection |
||||
URL |
Enter a path relative to
|
|||
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. |
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 BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body.
In our example, 3 images were returned:
Creates an animated gif.
Connection |
|||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||
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. |
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 triggerThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when the specified event occurs.