Webhooks - Corsair

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

contacts
- created (contacts.created)
- deleted (contacts.deleted)
- updated (contacts.updated)
domains
- created (domains.created)
- deleted (domains.deleted)
- updated (domains.updated)
emails
- bounced (emails.bounced)
- clicked (emails.clicked)
- complained (emails.complained)
- delivered (emails.delivered)
- failed (emails.failed)
- opened (emails.opened)
- received (emails.received)
- scheduled (emails.scheduled)
- sent (emails.sent)
- suppressed (emails.suppressed)

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

Contacts

Created

contacts.created A new contact was created Payload

Name	Type	Required	Description
`type`	`contact.created`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  id: string,
  email?: string,
  first_name?: string | null,
  last_name?: string | null,
  created_at?: string,
  unsubscribed?: boolean
}

Response data full type

{
  type: contact.created,
  created_at: string,
  data: {
    id: string,
    email?: string,
    first_name?: string | null,
    last_name?: string | null,
    created_at?: string,
    unsubscribed?: boolean
  }
}

webhookHooks example

resend({
    webhookHooks: {
        contacts: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Deleted

contacts.deleted A contact was deleted Payload

Name	Type	Required	Description
`type`	`contact.deleted`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  id: string,
  email?: string
}

Response data full type

{
  type: contact.deleted,
  created_at: string,
  data: {
    id: string,
    email?: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        contacts: {
            deleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Updated

contacts.updated A contact was updated Payload

Name	Type	Required	Description
`type`	`contact.updated`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  id: string,
  email?: string,
  first_name?: string | null,
  last_name?: string | null,
  created_at?: string,
  unsubscribed?: boolean
}

Response data full type

{
  type: contact.updated,
  created_at: string,
  data: {
    id: string,
    email?: string,
    first_name?: string | null,
    last_name?: string | null,
    created_at?: string,
    unsubscribed?: boolean
  }
}

webhookHooks example

resend({
    webhookHooks: {
        contacts: {
            updated: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Domains

Created

domains.created A new sending domain was created Payload

Name	Type	Required	Description
`type`	`domain.created`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  domain_id: string,
  name: string,
  status: not_started | validation | scheduled | ready | error | verified | pending | failed | partially_verified | partially_failed,
  created_at: string
}

Response data full type

{
  type: domain.created,
  created_at: string,
  data: {
    domain_id: string,
    name: string,
    status: not_started | validation | scheduled | ready | error | verified | pending | failed | partially_verified | partially_failed,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        domains: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Deleted

domains.deleted A sending domain was deleted Payload

Name	Type	Required	Description
`type`	`domain.deleted`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  id: string,
  name?: string
}

Response data full type

{
  type: domain.deleted,
  created_at: string,
  data: {
    id: string,
    name?: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        domains: {
            deleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Updated

domains.updated A sending domain was updated Payload

Name	Type	Required	Description
`type`	`domain.updated`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  domain_id: string,
  name: string,
  status: not_started | validation | scheduled | ready | error | verified | pending | failed | partially_verified | partially_failed,
  created_at: string
}

Response data full type

{
  type: domain.updated,
  created_at: string,
  data: {
    domain_id: string,
    name: string,
    status: not_started | validation | scheduled | ready | error | verified | pending | failed | partially_verified | partially_failed,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        domains: {
            updated: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Emails

Bounced

emails.bounced An email bounced and was not delivered Payload

Name	Type	Required	Description
`type`	`email.bounced`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string,
  bounce_type?: string
}

Response data full type

{
  type: email.bounced,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string,
    bounce_type?: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            bounced: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Clicked

emails.clicked A recipient clicked a link in an email Payload

Name	Type	Required	Description
`type`	`email.clicked`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string,
  link?: string
}

Response data full type

{
  type: email.clicked,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string,
    link?: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            clicked: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Complained

emails.complained A recipient marked an email as spam Payload

Name	Type	Required	Description
`type`	`email.complained`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string
}

Response data full type

{
  type: email.complained,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            complained: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Delivered

emails.delivered An email was delivered to the recipient Payload

Name	Type	Required	Description
`type`	`email.delivered`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string
}

Response data full type

{
  type: email.delivered,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            delivered: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Failed

emails.failed An email failed to send Payload

Name	Type	Required	Description
`type`	`email.failed`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string,
  error?: string
}

Response data full type

{
  type: email.failed,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string,
    error?: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            failed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Opened

emails.opened A recipient opened an email Payload

Name	Type	Required	Description
`type`	`email.opened`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string
}

Response data full type

{
  type: email.opened,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            opened: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Received

emails.received An inbound email was received Payload

Name	Type	Required	Description
`type`	`email.received`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string
}

Response data full type

{
  type: email.received,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            received: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Scheduled

emails.scheduled An email was scheduled to be sent Payload

Name	Type	Required	Description
`type`	`email.scheduled`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string
}

Response data full type

{
  type: email.scheduled,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            scheduled: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Sent

emails.sent An email was accepted and sent Payload

Name	Type	Required	Description
`type`	`email.sent`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string
}

Response data full type

{
  type: email.sent,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            sent: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Suppressed

emails.suppressed An email was suppressed Payload

Name	Type	Required	Description
`type`	`email.suppressed`	Yes	—
`created_at`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  email_id: string,
  from: string,
  to: string[],
  subject?: string,
  created_at: string,
  suppressed?: {
    message?: string,
    type?: string
  }
}

Response data full type

{
  type: email.suppressed,
  created_at: string,
  data: {
    email_id: string,
    from: string,
    to: string[],
    subject?: string,
    created_at: string,
    suppressed?: {
      message?: string,
      type?: string
    }
  }
}

webhookHooks example

resend({
    webhookHooks: {
        emails: {
            suppressed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Contacts

​Created

​Deleted

​Updated

​Domains

​Created

​Deleted

​Updated

​Emails

​Bounced

​Clicked

​Complained

​Delivered

​Failed

​Opened

​Received

​Scheduled

​Sent

​Suppressed

Webhook map

HTTP handler setup

Events

Contacts

Created

Deleted

Updated

Domains

Created

Deleted

Updated

Emails

Bounced

Clicked

Complained

Delivered

Failed

Opened

Received

Scheduled

Sent

Suppressed