Webhooks - Corsair

The Abyssale 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

banners
- batchCompleted (banners.batchCompleted)
- created (banners.created)
designs
- statusChanged (designs.statusChanged)
exports
- completed (exports.completed)

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

Banners

Batch Completed

banners.batchCompleted An asynchronous batch generation request completed (NEW_BANNER_BATCH event) Payload

Name	Type	Required	Description
`event_type`	`NEW_BANNER_BATCH`	Yes	—
`generation_request_id`	`string`	Yes	—
`banners`	`object[]`	Yes	—
`errors`	`object[]`	Yes	—

banners full type

{
  id: string,
  version?: number,
  sharing_id?: string,
  file?: {
    type?: string,
    url?: string,
    cdn_url?: string,
    fallback_image_url?: string,
    filename?: string
  },
  format?: {
    id?: string,
    width?: number,
    height?: number,
    unit?: string
  },
  template?: {
    id?: string,
    name?: string,
    created_at?: number,
    updated_at?: number
  },
  project?: {
    id?: string,
    name?: string
  }
}[]

errors full type

{
  template_format_name: string,
  reason: string
}[]

Response data full type

{
  event_type: NEW_BANNER_BATCH,
  generation_request_id: string,
  banners: {
    id: string,
    version?: number,
    sharing_id?: string,
    file?: {
      type?: string,
      url?: string,
      cdn_url?: string,
      fallback_image_url?: string,
      filename?: string
    },
    format?: {
      id?: string,
      width?: number,
      height?: number,
      unit?: string
    },
    template?: {
      id?: string,
      name?: string,
      created_at?: number,
      updated_at?: number
    },
    project?: {
      id?: string,
      name?: string
    }
  }[],
  errors: {
    template_format_name: string,
    reason: string
  }[]
}

webhookHooks example

abyssale({
    webhookHooks: {
        banners: {
            batchCompleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Created

banners.created A visual was generated or saved in Abyssale (NEW_BANNER event) Payload

Name	Type	Required	Description
`event_type`	`NEW_BANNER`	Yes	—
`id`	`string`	Yes	—
`version`	`number`	No	—
`sharing_id`	`string`	No	—
`file`	`object`	No	—
`format`	`object`	No	—
`template`	`object`	No	—

file full type

{
  type?: string,
  url?: string,
  cdn_url?: string,
  fallback_image_url?: string,
  filename?: string
}

format full type

{
  id?: string,
  width?: number,
  height?: number,
  unit?: string
}

template full type

{
  id?: string,
  name?: string,
  created_at?: number,
  updated_at?: number
}

Response data full type

{
  event_type: NEW_BANNER,
  id: string,
  version?: number,
  sharing_id?: string,
  file?: {
    type?: string,
    url?: string,
    cdn_url?: string,
    fallback_image_url?: string,
    filename?: string
  },
  format?: {
    id?: string,
    width?: number,
    height?: number,
    unit?: string
  },
  template?: {
    id?: string,
    name?: string,
    created_at?: number,
    updated_at?: number
  }
}

webhookHooks example

abyssale({
    webhookHooks: {
        banners: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Designs

Status Changed

designs.statusChanged A design’s workflow status was updated (TEMPLATE_STATUS event) Payload

Name	Type	Required	Description
`event_type`	`TEMPLATE_STATUS`	Yes	—
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	Yes	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—
`status_updated_at`	`number`	No	—

Response data full type

{
  event_type: TEMPLATE_STATUS,
  id: string,
  name?: string,
  status: string,
  created_at?: number,
  updated_at?: number,
  status_updated_at?: number
}

webhookHooks example

abyssale({
    webhookHooks: {
        designs: {
            statusChanged: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Exports

Completed

exports.completed A workspace export archive finished processing (NEW_EXPORT event) Payload

Name	Type	Required	Description
`event_type`	`NEW_EXPORT`	Yes	—
`export_id`	`string`	Yes	—
`archive_url`	`string`	Yes	—
`requested_at`	`number`	No	—
`generated_at`	`number`	No	—

Response data full type

{
  event_type: NEW_EXPORT,
  export_id: string,
  archive_url: string,
  requested_at?: number,
  generated_at?: number
}

webhookHooks example

abyssale({
    webhookHooks: {
        exports: {
            completed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Banners

​Batch Completed

​Created

​Designs

​Status Changed

​Exports

​Completed

Webhook map

HTTP handler setup

Events

Banners

Batch Completed

Created

Designs

Status Changed

Exports

Completed