Userlist webhooks

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

companyCreated (companyCreated)
companyUpdated (companyUpdated)
formSubmitted (formSubmitted)
messageBounced (messageBounced)
messageClicked (messageClicked)
messageEnqueued (messageEnqueued)
messageOpened (messageOpened)
messageReported (messageReported)
relationshipCreated (relationshipCreated)
relationshipUpdated (relationshipUpdated)
userCreated (userCreated)
userSubscribed (userSubscribed)
userUnsubscribed (userUnsubscribed)
userUpdated (userUpdated)

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

Company Created

companyCreated Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        companyCreated: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Company Updated

companyUpdated Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        companyUpdated: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Form Submitted

formSubmitted Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        formSubmitted: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Message Bounced

messageBounced Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        messageBounced: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Message Clicked

messageClicked Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        messageClicked: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Message Enqueued

messageEnqueued Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        messageEnqueued: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Message Opened

messageOpened Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        messageOpened: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Message Reported

messageReported Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        messageReported: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Relationship Created

relationshipCreated Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        relationshipCreated: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

Relationship Updated

relationshipUpdated Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        relationshipUpdated: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

User Created

userCreated Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        userCreated: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

User Subscribed

userSubscribed Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        userSubscribed: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

User Unsubscribed

userUnsubscribed Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        userUnsubscribed: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

User Updated

userUpdated Payload: unknown webhookHooks example

userlist({
    webhookHooks: {
        userUpdated: {
            before(ctx, args) {
                return { ctx, args };
            },
            after(ctx, response) {
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Company Created

​Company Created

​Company Updated

​Company Updated

​Form Submitted

​Form Submitted

​Message Bounced

​Message Bounced

​Message Clicked

​Message Clicked

​Message Enqueued

​Message Enqueued

​Message Opened

​Message Opened

​Message Reported

​Message Reported

​Relationship Created

​Relationship Created

​Relationship Updated

​Relationship Updated

​User Created

​User Created

​User Subscribed

​User Subscribed

​User Unsubscribed

​User Unsubscribed

​User Updated

​User Updated

Webhook map

HTTP handler setup

Events

Company Created

Company Created

Company Updated

Company Updated

Form Submitted

Form Submitted

Message Bounced

Message Bounced

Message Clicked

Message Clicked

Message Enqueued

Message Enqueued

Message Opened

Message Opened

Message Reported

Message Reported

Relationship Created

Relationship Created

Relationship Updated

Relationship Updated

User Created

User Created

User Subscribed

User Subscribed

User Unsubscribed

User Unsubscribed

User Updated

User Updated