Webhooks - Corsair

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

collections
- collectionCompleted (collections.collectionCompleted)

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

Collections

Collection Completed

collections.collectionCompleted Fires when a Collection completes and a new Result Set is available Payload

Name	Type	Required	Description
`request_info`	`object`	Yes	—
`collection`	`object`	Yes	—
`result_set`	`object`	Yes	—

request_info full type

{
  success?: boolean,
  type?: collection_resultset_completed
}

collection full type

{
  id: string,
  name?: string
}

result_set full type

{
  id: number | string,
  started_at?: string,
  ended_at?: string,
  requests_completed?: number,
  requests_failed?: number,
  download_links?: {
    json?: {
      pages?: string[],
      all_pages?: string
    },
    jsonlines?: {
      pages?: string[],
      all_pages?: string
    },
    csv?: {
      pages?: string[],
      all_pages?: string
    }
  }
}

Response data full type

{
  request_info: {
    success?: boolean,
    type?: collection_resultset_completed
  },
  collection: {
    id: string,
    name?: string
  },
  result_set: {
    id: number | string,
    started_at?: string,
    ended_at?: string,
    requests_completed?: number,
    requests_failed?: number,
    download_links?: {
      json?: {
        pages?: string[],
        all_pages?: string
      },
      jsonlines?: {
        pages?: string[],
        all_pages?: string
      },
      csv?: {
        pages?: string[],
        all_pages?: string
      }
    }
  }
}

webhookHooks example

asindataapi({
    webhookHooks: {
        collections: {
            collectionCompleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Collections

​Collection Completed

Webhook map

HTTP handler setup

Events

Collections

Collection Completed