Webhooks - Corsair

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

campaign (campaign)
profile (profile)
subscribe (subscribe)
unsubscribe (unsubscribe)

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

Campaign

campaign Fired when a campaign is sent. Payload

Name	Type	Required	Description
`type`	`campaign`	Yes	—
`created_at`	`string`	No	—
`fired_at`	`string`	No	—
`data`	`object`	Yes	—

data full type

{
  id?: string,
  list_id?: string,
  subject?: string,
  status?: string
}

Response data full type

{
  type: campaign,
  created_at?: string,
  fired_at?: string,
  data: {
    id?: string,
    list_id?: string,
    subject?: string,
    status?: string
  }
}

webhookHooks example

mailchimp({
    webhookHooks: {
        campaign: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Profile

profile Fired when a subscriber updates their profile. Payload

Name	Type	Required	Description
`type`	`profile`	Yes	—
`created_at`	`string`	No	—
`fired_at`	`string`	No	—
`data`	`object`	Yes	—

data full type

{
  id?: string,
  list_id?: string,
  email?: string,
  merges?: {
  }
}

Response data full type

{
  type: profile,
  created_at?: string,
  fired_at?: string,
  data: {
    id?: string,
    list_id?: string,
    email?: string,
    merges?: {
    }
  }
}

webhookHooks example

mailchimp({
    webhookHooks: {
        profile: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

subscribe Fired when a subscriber joins a list. Payload

Name	Type	Required	Description
`type`	`subscribe`	Yes	—
`created_at`	`string`	No	—
`fired_at`	`string`	No	—
`data`	`object`	Yes	—

data full type

{
  id?: string,
  list_id?: string,
  email?: string,
  merges?: {
  }
}

Response data full type

{
  type: subscribe,
  created_at?: string,
  fired_at?: string,
  data: {
    id?: string,
    list_id?: string,
    email?: string,
    merges?: {
    }
  }
}

webhookHooks example

mailchimp({
    webhookHooks: {
        subscribe: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Unsubscribe

unsubscribe Fired when a subscriber leaves a list. Payload

Name	Type	Required	Description
`type`	`unsubscribe`	Yes	—
`created_at`	`string`	No	—
`fired_at`	`string`	No	—
`data`	`object`	Yes	—

data full type

{
  id?: string,
  list_id?: string,
  email?: string,
  merges?: {
  }
}

Response data full type

{
  type: unsubscribe,
  created_at?: string,
  fired_at?: string,
  data: {
    id?: string,
    list_id?: string,
    email?: string,
    merges?: {
    }
  }
}

webhookHooks example

mailchimp({
    webhookHooks: {
        unsubscribe: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Campaign

​Campaign

​Profile

​Profile

​Subscribe

​Subscribe

​Unsubscribe

​Unsubscribe

Webhook map

HTTP handler setup

Events

Campaign

Campaign

Profile

Profile

Subscribe

Subscribe

Unsubscribe

Unsubscribe