Bannerbear

Bannerbear Webhooks API

The Webhooks API from Bannerbear — 2 operation(s) for webhooks.

GitHub OpenAPI

Operations 5

GET /webhooks List webhooks #
POST /webhooks Create a webhook #
GET /webhooks/{uid} Get a webhook #
PATCH /webhooks/{uid} Update a webhook #
DELETE /webhooks/{uid} Delete a webhook #

Documentation

📖
Documentation
https://www.bannerbear.com/product/image-generation-api/
📖
APIReference
https://developers.bannerbear.com/
📖
Documentation
https://www.bannerbear.com/product/video-generation-api/
📖
Documentation
https://www.bannerbear.com/help/articles/159-create-a-collection-via-api/
📖
Documentation
https://www.bannerbear.com/product/url-to-screenshot-api/
📖
Documentation
https://developers.bannerbear.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bannerbear/refs/heads/main/openapi/bannerbear-webhooks-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bannerbear/refs/heads/main/collections/bannerbear.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bannerbear:bannerbear-webhooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bannerbear-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bannerbear V5 Webhooks API
  version: '5.0'
servers:
- url: https://api.bannerbear.com/v5
  description: Async render host. All endpoints.
- url: https://sync.api.bannerbear.com/v5
  description: Synchronous render host. Only accepts POST /images — returns the finished image inline instead of a pending record. Long-running requests may return 408.
security:
- bearerAuth: []
tags:
- name: Webhooks
paths:
  /webhooks:
    get:
      summary: List webhooks
      parameters:
      - name: page
        in: query
        schema:
          type: integer
        required: false
      responses:
        '200':
          description: Paginated list of webhooks
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    uid:
                      type: string
                    name:
                      type: string
                    url:
                      type: string
                      format: uri
                    resource:
                      type: string
                      enum:
                      - image
                      - batch
                      - tool_job
                      - workflow_run
                      - animation
                    event:
                      type: string
                      enum:
                      - all_events
                      - completed
                      - failed
                    status:
                      type: string
                      enum:
                      - active
                      - disabled
                    created_at:
                      type: string
                      format: date-time
      tags:
      - Webhooks
      operationId: getWebhooks
      x-operation-id-source: derived
    post:
      summary: Create a webhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - url
              properties:
                name:
                  type: string
                  description: Webhook name
                url:
                  type: string
                  format: uri
                  description: URL to receive webhook events
                resource:
                  type: string
                  enum:
                  - image
                  - batch
                  - tool_job
                  - workflow_run
                  - animation
                  description: Resource type to trigger on
                event:
                  type: string
                  enum:
                  - all_events
                  - completed
                  - failed
                  description: Event type to trigger on
                status:
                  type: string
                  enum:
                  - active
                  - disabled
                  description: Webhook status
      responses:
        '201':
          description: Webhook created. The signing_key field is only returned here — store it now.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uid:
                    type: string
                  name:
                    type: string
                  url:
                    type: string
                    format: uri
                  resource:
                    type: string
                    enum:
                    - image
                    - batch
                    - tool_job
                    - workflow_run
                    - animation
                  event:
                    type: string
                    enum:
                    - all_events
                    - completed
                    - failed
                  status:
                    type: string
                    enum:
                    - active
                    - disabled
                  created_at:
                    type: string
                    format: date-time
                  signing_key:
                    type: string
                    description: HMAC signing key. Only returned at creation time — store it now.
        '422':
          description: Validation failure — e.g. missing name/url, invalid resource/event/scope enum
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Human-readable explanation of the error
      tags:
      - Webhooks
      operationId: postWebhooks
      x-operation-id-source: derived
  /webhooks/{uid}:
    get:
      summary: Get a webhook
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Webhook details
          content:
            application/json:
              schema:
                type: object
                properties:
                  uid:
                    type: string
                  name:
                    type: string
                  url:
                    type: string
                    format: uri
                  resource:
                    type: string
                    enum:
                    - image
                    - batch
                    - tool_job
                    - workflow_run
                    - animation
                  event:
                    type: string
                    enum:
                    - all_events
                    - completed
                    - failed
                  status:
                    type: string
                    enum:
                    - active
                    - disabled
                  created_at:
                    type: string
                    format: date-time
      tags:
      - Webhooks
      operationId: getWebhooksByUid
      x-operation-id-source: derived
    patch:
      summary: Update a webhook
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - url
              properties:
                name:
                  type: string
                  description: Webhook name
                url:
                  type: string
                  format: uri
                  description: URL to receive webhook events
                resource:
                  type: string
                  enum:
                  - image
                  - batch
                  - tool_job
                  - workflow_run
                  - animation
                  description: Resource type to trigger on
                event:
                  type: string
                  enum:
                  - all_events
                  - completed
                  - failed
                  description: Event type to trigger on
                status:
                  type: string
                  enum:
                  - active
                  - disabled
                  description: Webhook status
      responses:
        '200':
          description: Updated webhook
          content:
            application/json:
              schema:
                type: object
                properties:
                  uid:
                    type: string
                  name:
                    type: string
                  url:
                    type: string
                    format: uri
                  resource:
                    type: string
                    enum:
                    - image
                    - batch
                    - tool_job
                    - workflow_run
                    - animation
                  event:
                    type: string
                    enum:
                    - all_events
                    - completed
                    - failed
                  status:
                    type: string
                    enum:
                    - active
                    - disabled
                  created_at:
                    type: string
                    format: date-time
        '404':
          description: Webhook not found in this workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Human-readable explanation of the error
        '422':
          description: Validation failure
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Human-readable explanation of the error
      tags:
      - Webhooks
      operationId: patchWebhooksByUid
      x-operation-id-source: derived
    delete:
      summary: Delete a webhook
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Webhook deleted
      tags:
      - Webhooks
      operationId: deleteWebhooksByUid
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key (e.g. bb_ak_v5_...)
x-provenance:
  method: harvested
  publisher: Bannerbear
  source: https://api.bannerbear.com/v5/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)