Webhooks - Corsair

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

channels
- created (channels.created)
messages
- botMessage (messages.botMessage)
- directMessage (messages.directMessage)
- groupDirectMessage (messages.groupDirectMessage)
- message (messages.message)
- privateChannelMessage (messages.privateChannelMessage)
- threadReply (messages.threadReply)
reactions
- added (reactions.added)
- removed (reactions.removed)
setup
- challenge (setup.challenge)

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

Channels

Created

channels.created A new channel created in the workspace Payload

Name	Type	Required	Description
`type`	`channel_created`	Yes	—
`channel`	`object`	Yes	—
`event_ts`	`string`	No	—

channel full type

{
  id: string,
  name?: string,
  created?: number,
  creator?: string,
  is_channel?: boolean,
  is_private?: boolean
}

Response data full type

{
  type: channel_created,
  channel: {
    id: string,
    name?: string,
    created?: number,
    creator?: string,
    is_channel?: boolean,
    is_private?: boolean
  },
  event_ts?: string
}

webhookHooks example

slackbot({
    webhookHooks: {
        channels: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Messages

Bot Message

messages.botMessage A message posted by another bot or app Payload

Name	Type	Required	Description
`type`	`message`	Yes	—
`subtype`	`string`	No	—
`channel`	`string`	Yes	—
`channel_type`	`channel \| group \| im \| mpim`	No	—
`user`	`string`	No	—
`bot_id`	`string`	No	—
`app_id`	`string`	No	—
`bot_profile`	`object`	No	—
`text`	`string`	No	—
`ts`	`string`	Yes	—
`thread_ts`	`string`	No	—
`parent_user_id`	`string`	No	—
`team`	`string`	No	—
`event_ts`	`string`	No	—
`blocks`	`object[]`	No	—
`files`	`object[]`	No	—

bot_profile full type

{
}

blocks full type

{
}[]

files full type

{
}[]

Response data full type

{
  type: message,
  subtype?: string,
  channel: string,
  channel_type?: channel | group | im | mpim,
  user?: string,
  bot_id?: string,
  app_id?: string,
  bot_profile?: {
  },
  text?: string,
  ts: string,
  thread_ts?: string,
  parent_user_id?: string,
  team?: string,
  event_ts?: string,
  blocks?: {
  }[],
  files?: {
  }[]
}

webhookHooks example

slackbot({
    webhookHooks: {
        messages: {
            botMessage: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Direct Message

messages.directMessage A direct message sent to the bot Payload

Name	Type	Required	Description
`type`	`message`	Yes	—
`subtype`	`string`	No	—
`channel`	`string`	Yes	—
`channel_type`	`channel \| group \| im \| mpim`	No	—
`user`	`string`	No	—
`bot_id`	`string`	No	—
`app_id`	`string`	No	—
`bot_profile`	`object`	No	—
`text`	`string`	No	—
`ts`	`string`	Yes	—
`thread_ts`	`string`	No	—
`parent_user_id`	`string`	No	—
`team`	`string`	No	—
`event_ts`	`string`	No	—
`blocks`	`object[]`	No	—
`files`	`object[]`	No	—

bot_profile full type

{
}

blocks full type

{
}[]

files full type

{
}[]

Response data full type

{
  type: message,
  subtype?: string,
  channel: string,
  channel_type?: channel | group | im | mpim,
  user?: string,
  bot_id?: string,
  app_id?: string,
  bot_profile?: {
  },
  text?: string,
  ts: string,
  thread_ts?: string,
  parent_user_id?: string,
  team?: string,
  event_ts?: string,
  blocks?: {
  }[],
  files?: {
  }[]
}

webhookHooks example

slackbot({
    webhookHooks: {
        messages: {
            directMessage: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Group Direct Message

messages.groupDirectMessage A message in a multi-person direct message Payload

Name	Type	Required	Description
`type`	`message`	Yes	—
`subtype`	`string`	No	—
`channel`	`string`	Yes	—
`channel_type`	`channel \| group \| im \| mpim`	No	—
`user`	`string`	No	—
`bot_id`	`string`	No	—
`app_id`	`string`	No	—
`bot_profile`	`object`	No	—
`text`	`string`	No	—
`ts`	`string`	Yes	—
`thread_ts`	`string`	No	—
`parent_user_id`	`string`	No	—
`team`	`string`	No	—
`event_ts`	`string`	No	—
`blocks`	`object[]`	No	—
`files`	`object[]`	No	—

bot_profile full type

{
}

blocks full type

{
}[]

files full type

{
}[]

Response data full type

{
  type: message,
  subtype?: string,
  channel: string,
  channel_type?: channel | group | im | mpim,
  user?: string,
  bot_id?: string,
  app_id?: string,
  bot_profile?: {
  },
  text?: string,
  ts: string,
  thread_ts?: string,
  parent_user_id?: string,
  team?: string,
  event_ts?: string,
  blocks?: {
  }[],
  files?: {
  }[]
}

webhookHooks example

slackbot({
    webhookHooks: {
        messages: {
            groupDirectMessage: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Message

messages.message A message posted by a person in a public channel Payload

Name	Type	Required	Description
`type`	`message`	Yes	—
`subtype`	`string`	No	—
`channel`	`string`	Yes	—
`channel_type`	`channel \| group \| im \| mpim`	No	—
`user`	`string`	No	—
`bot_id`	`string`	No	—
`app_id`	`string`	No	—
`bot_profile`	`object`	No	—
`text`	`string`	No	—
`ts`	`string`	Yes	—
`thread_ts`	`string`	No	—
`parent_user_id`	`string`	No	—
`team`	`string`	No	—
`event_ts`	`string`	No	—
`blocks`	`object[]`	No	—
`files`	`object[]`	No	—

bot_profile full type

{
}

blocks full type

{
}[]

files full type

{
}[]

Response data full type

{
  type: message,
  subtype?: string,
  channel: string,
  channel_type?: channel | group | im | mpim,
  user?: string,
  bot_id?: string,
  app_id?: string,
  bot_profile?: {
  },
  text?: string,
  ts: string,
  thread_ts?: string,
  parent_user_id?: string,
  team?: string,
  event_ts?: string,
  blocks?: {
  }[],
  files?: {
  }[]
}

webhookHooks example

slackbot({
    webhookHooks: {
        messages: {
            message: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Private Channel Message

messages.privateChannelMessage A message posted by a person in a private channel Payload

Name	Type	Required	Description
`type`	`message`	Yes	—
`subtype`	`string`	No	—
`channel`	`string`	Yes	—
`channel_type`	`channel \| group \| im \| mpim`	No	—
`user`	`string`	No	—
`bot_id`	`string`	No	—
`app_id`	`string`	No	—
`bot_profile`	`object`	No	—
`text`	`string`	No	—
`ts`	`string`	Yes	—
`thread_ts`	`string`	No	—
`parent_user_id`	`string`	No	—
`team`	`string`	No	—
`event_ts`	`string`	No	—
`blocks`	`object[]`	No	—
`files`	`object[]`	No	—

bot_profile full type

{
}

blocks full type

{
}[]

files full type

{
}[]

Response data full type

{
  type: message,
  subtype?: string,
  channel: string,
  channel_type?: channel | group | im | mpim,
  user?: string,
  bot_id?: string,
  app_id?: string,
  bot_profile?: {
  },
  text?: string,
  ts: string,
  thread_ts?: string,
  parent_user_id?: string,
  team?: string,
  event_ts?: string,
  blocks?: {
  }[],
  files?: {
  }[]
}

webhookHooks example

slackbot({
    webhookHooks: {
        messages: {
            privateChannelMessage: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Thread Reply

messages.threadReply A reply posted inside a message thread Payload

Name	Type	Required	Description
`type`	`message`	Yes	—
`subtype`	`string`	No	—
`channel`	`string`	Yes	—
`channel_type`	`channel \| group \| im \| mpim`	No	—
`user`	`string`	No	—
`bot_id`	`string`	No	—
`app_id`	`string`	No	—
`bot_profile`	`object`	No	—
`text`	`string`	No	—
`ts`	`string`	Yes	—
`thread_ts`	`string`	No	—
`parent_user_id`	`string`	No	—
`team`	`string`	No	—
`event_ts`	`string`	No	—
`blocks`	`object[]`	No	—
`files`	`object[]`	No	—

bot_profile full type

{
}

blocks full type

{
}[]

files full type

{
}[]

Response data full type

{
  type: message,
  subtype?: string,
  channel: string,
  channel_type?: channel | group | im | mpim,
  user?: string,
  bot_id?: string,
  app_id?: string,
  bot_profile?: {
  },
  text?: string,
  ts: string,
  thread_ts?: string,
  parent_user_id?: string,
  team?: string,
  event_ts?: string,
  blocks?: {
  }[],
  files?: {
  }[]
}

webhookHooks example

slackbot({
    webhookHooks: {
        messages: {
            threadReply: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Reactions

Added

reactions.added An emoji reaction added to a message or file Payload

Name	Type	Required	Description
`type`	`reaction_added`	Yes	—
`user`	`string`	Yes	—
`reaction`	`string`	Yes	—
`item_user`	`string`	No	—
`item`	`object`	Yes	—
`event_ts`	`string`	No	—

item full type

{
  type: string,
  channel?: string,
  ts?: string,
  file?: string
}

Response data full type

{
  type: reaction_added,
  user: string,
  reaction: string,
  item_user?: string,
  item: {
    type: string,
    channel?: string,
    ts?: string,
    file?: string
  },
  event_ts?: string
}

webhookHooks example

slackbot({
    webhookHooks: {
        reactions: {
            added: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Removed

reactions.removed An emoji reaction removed from a message or file Payload

Name	Type	Required	Description
`type`	`reaction_removed`	Yes	—
`user`	`string`	Yes	—
`reaction`	`string`	Yes	—
`item_user`	`string`	No	—
`item`	`object`	Yes	—
`event_ts`	`string`	No	—

item full type

{
  type: string,
  channel?: string,
  ts?: string,
  file?: string
}

Response data full type

{
  type: reaction_removed,
  user: string,
  reaction: string,
  item_user?: string,
  item: {
    type: string,
    channel?: string,
    ts?: string,
    file?: string
  },
  event_ts?: string
}

webhookHooks example

slackbot({
    webhookHooks: {
        reactions: {
            removed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Setup

Challenge

setup.challenge Slack Events API URL verification handshake Payload

Name	Type	Required	Description
`type`	`url_verification`	Yes	—
`token`	`string`	No	—
`challenge`	`string`	Yes	—

Response data full type

{
  type: url_verification,
  challenge: string
}

webhookHooks example

slackbot({
    webhookHooks: {
        setup: {
            challenge: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Channels

​Created

​Messages

​Bot Message

​Direct Message

​Group Direct Message

​Message

​Private Channel Message

​Thread Reply

​Reactions

​Added

​Removed

​Setup

​Challenge

Webhook map

HTTP handler setup

Events

Channels

Created

Messages

Bot Message

Direct Message

Group Direct Message

Message

Private Channel Message

Thread Reply

Reactions

Added

Removed

Setup

Challenge