Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Bannerbear

Automate image generation

CategoryMarketing
Authenticationcustom
Version0.5.0
Published scopes0 published scopes
Last updatedSeptember 19, 2026

Overview

Bannerbear

This CDK catalogue package is pinned to @activepieces/piece-bannerbear@0.5.0 and declares 2 declared actions and no declared triggers. Its definition is derived from the exact reviewed Activepieces source.

Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.

Technical guide

Technical reference

  • Package: @activepieces/piece-bannerbear@0.5.0
  • Exact artifact digest: sha256:0cb6b4221cd1a42ac6267171671f42286e3cc16e761ac09b8a2b66185875975f
  • Source: the exact reviewed Activepieces source
  • Authentication, action and trigger schemas are taken from the exact pinned package.

Capability summary

Authenticationcustom
Supported objects2
Supported actions2
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • API Key Required · protected credential

Supported objects

ObjectReadWriteNotes
Create Image Yes No
Custom API Call Yes No

Supported actions

Create Image · Read

Create image from Bannerbear template

bannerbear_create_image · Risk: low · Retry: safe

Inputs

  • template · string · Required, The template to use in image creation.
  • template_version · number · Optional, Create image based on a specific version of the template.
  • modifications · object · Required, A list of modifications you want to make on the template.
  • transparent · boolean · Optional, Render a PNG with a transparent background. Default is false.
  • render_pdf · boolean · Optional, Render a PDF instead of a PNG. Default is false.
  • metadata · string · Optional, Any metadata that you need to store e.g. ID of a record in your DB.
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Setup

Setup

Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.

Limitations

The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.

github.com