Webhooks - Corsair

The Bannerbear plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see Overview for setup context and the exact URL shape).

New to Corsair? See webhooks and hooks.

Webhook map

animation
- animationCompleted (animation.animationCompleted)
image
- imageCompleted (image.imageCompleted)

HTTP handler setup

app/api/webhook/route.ts

import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    const body = await request.json();
    const result = await processWebhook(corsair, headers, body);
    return result.response;
}

Events

Animation

Animation Completed

animation.animationCompleted Fires when a Bannerbear animation finishes rendering Payload

Name	Type	Required	Description
`uid`	`string`	Yes	—
`status`	`completed`	Yes	—
`template`	`string`	No	—
`files`	`object`	No	—
`progress`	`number`	No	—
`metadata`	`string`	No	—
`self`	`string`	No	—
`created_at`	`string`	No	—
`completed_at`	`string`	No	—

files full type

{
}

Response data full type

{
  uid: string,
  status: completed,
  template?: string,
  files?: {
  },
  progress?: number,
  metadata?: string,
  self?: string,
  created_at?: string,
  completed_at?: string
}

webhookHooks example

bannerbear({
    webhookHooks: {
        animation: {
            animationCompleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Image

Image Completed

image.imageCompleted Fires when a Bannerbear image finishes rendering Payload

Name	Type	Required	Description
`uid`	`string`	Yes	—
`status`	`completed`	Yes	—
`template`	`string`	No	—
`files`	`object`	No	—
`metadata`	`string`	No	—
`self`	`string`	No	—
`created_at`	`string`	No	—
`completed_at`	`string`	No	—

files full type

{
}

Response data full type

{
  uid: string,
  status: completed,
  template?: string,
  files?: {
  },
  metadata?: string,
  self?: string,
  created_at?: string,
  completed_at?: string
}

webhookHooks example

bannerbear({
    webhookHooks: {
        image: {
            imageCompleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Animation

​Animation Completed

​Image

​Image Completed

Webhook map

HTTP handler setup

Events

Animation

Animation Completed

Image

Image Completed