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/ https //www bannerbear com/ connect bannerbear to make to connect your bannerbear account to make you need to obtain the api key from your bannerbear account and insert it in the create a connection dialog in the make 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 make 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 image watch new image watches for a new image see the bannerbear docid\ pcq3yhxvoheahzbjxknh7 for adding the webhooks in your bannerbear account webhook name enter (map) a name for the webhook connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 list images lists all images connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 limit set the maximum number of images make should return during one execution cycle get an image gets an image connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 image uuid select or map the image uuid whose details you want to retrieve create an image creates an image connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 list videos lists all videos connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 limit set the maximum number of videos make should return during one execution cycle status select or map the status of the video completed pending approva l get a video gets a video connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 video uuid select or map the video uuid whose details you want to retrieve create a video creates a video connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 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 connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 video uuid select or map the video uuid you want to approve delete a video rejects a video connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 video uuid select or map the video uuid you want to delete collection list collections lists all collections connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 limit set the maximum number of collections make should return during one execution cycle get a collection gets a collection connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 collection uuid select or map the collection uuid whose details you want to retrieve create a collection creates a collection connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 bannerbear docid\ pcq3yhxvoheahzbjxknh7 for adding the webhooks in your bannerbear account webhook name enter (map) a name for the webhook connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 make an api call performs an arbitrary authorized api call connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 url enter a path relative to https //api bannerbear com for example /v1/collections note 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 connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 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 connection bannerbear docid\ pcq3yhxvoheahzbjxknh7 setting up bannerbear webhooks 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 make and run the scenario to receive the trigger when the specified event occurs