Webhooks - Corsair

The TwitterAPI.io 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

tweets
- created (tweets.created)
- filterMatch (tweets.filterMatch)

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

Tweets

Created

tweets.created A monitored user posted a new tweet Payload

Name	Type	Required	Description
`type`	`tweet.created`	Yes	—
`data`	`object`	Yes	—
`timestamp`	`string`	No	—
`userId`	`string`	No	—

data full type

{
  tweet: {
    id: string,
    text: string,
    author?: {
      id: string,
      userName: string,
      name: string,
      followerCount?: number,
      followingCount?: number,
      profilePicture?: string | null,
      coverPicture?: string | null,
      description?: string | null,
      location?: string | null,
      isBlueVerified?: boolean,
      isGovernmentVerified?: boolean,
      favouritesCount?: number,
      statusesCount?: number,
      mediaCount?: number,
      createdAt?: string,
      isProtected?: boolean,
      isSuspended?: boolean,
      isUnavailable?: boolean,
      pinnedTweetIds?: string[],
      website?: string | null
    },
    createdAt?: string,
    likeCount?: number,
    retweetCount?: number,
    replyCount?: number,
    quoteCount?: number,
    viewCount?: number | null,
    bookmarkCount?: number,
    lang?: string,
    source?: string,
    isRetweet?: boolean,
    isQuote?: boolean,
    isPinned?: boolean,
    inReplyToStatusId?: string | null,
    inReplyToUserId?: string | null,
    quotedTweetId?: string | null,
    media?: {
      type?: string,
      url?: string,
      mediaUrlHttps?: string,
      expandedUrl?: string,
      width?: number,
      height?: number,
      altText?: string | null,
      durationMs?: number | null
    }[],
    entities?: {
      urls?: {
        url?: string,
        expandedUrl?: string,
        displayUrl?: string
      }[],
      hashtags?: {
        text?: string
      }[],
      userMentions?: {
        id?: string,
        name?: string,
        screenName?: string
      }[]
    },
    conversationId?: string
  },
  user?: {
    id: string,
    userName: string,
    name: string,
    followerCount?: number,
    followingCount?: number,
    profilePicture?: string | null,
    coverPicture?: string | null,
    description?: string | null,
    location?: string | null,
    isBlueVerified?: boolean,
    isGovernmentVerified?: boolean,
    favouritesCount?: number,
    statusesCount?: number,
    mediaCount?: number,
    createdAt?: string,
    isProtected?: boolean,
    isSuspended?: boolean,
    isUnavailable?: boolean,
    pinnedTweetIds?: string[],
    website?: string | null
  }
}

Response data full type

{
  type: tweet.created,
  data: {
    tweet: {
      id: string,
      text: string,
      author?: {
        id: string,
        userName: string,
        name: string,
        followerCount?: number,
        followingCount?: number,
        profilePicture?: string | null,
        coverPicture?: string | null,
        description?: string | null,
        location?: string | null,
        isBlueVerified?: boolean,
        isGovernmentVerified?: boolean,
        favouritesCount?: number,
        statusesCount?: number,
        mediaCount?: number,
        createdAt?: string,
        isProtected?: boolean,
        isSuspended?: boolean,
        isUnavailable?: boolean,
        pinnedTweetIds?: string[],
        website?: string | null
      },
      createdAt?: string,
      likeCount?: number,
      retweetCount?: number,
      replyCount?: number,
      quoteCount?: number,
      viewCount?: number | null,
      bookmarkCount?: number,
      lang?: string,
      source?: string,
      isRetweet?: boolean,
      isQuote?: boolean,
      isPinned?: boolean,
      inReplyToStatusId?: string | null,
      inReplyToUserId?: string | null,
      quotedTweetId?: string | null,
      media?: {
        type?: string,
        url?: string,
        mediaUrlHttps?: string,
        expandedUrl?: string,
        width?: number,
        height?: number,
        altText?: string | null,
        durationMs?: number | null
      }[],
      entities?: {
        urls?: {
          url?: string,
          expandedUrl?: string,
          displayUrl?: string
        }[],
        hashtags?: {
          text?: string
        }[],
        userMentions?: {
          id?: string,
          name?: string,
          screenName?: string
        }[]
      },
      conversationId?: string
    },
    user?: {
      id: string,
      userName: string,
      name: string,
      followerCount?: number,
      followingCount?: number,
      profilePicture?: string | null,
      coverPicture?: string | null,
      description?: string | null,
      location?: string | null,
      isBlueVerified?: boolean,
      isGovernmentVerified?: boolean,
      favouritesCount?: number,
      statusesCount?: number,
      mediaCount?: number,
      createdAt?: string,
      isProtected?: boolean,
      isSuspended?: boolean,
      isUnavailable?: boolean,
      pinnedTweetIds?: string[],
      website?: string | null
    }
  },
  timestamp?: string,
  userId?: string
}

webhookHooks example

twitterapiio({
    webhookHooks: {
        tweets: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Filter Match

tweets.filterMatch A tweet matched a configured filter rule Payload

Name	Type	Required	Description
`type`	`tweet.filter_match`	Yes	—
`data`	`object`	Yes	—
`timestamp`	`string`	No	—

data full type

{
  tweet: {
    id: string,
    text: string,
    author?: {
      id: string,
      userName: string,
      name: string,
      followerCount?: number,
      followingCount?: number,
      profilePicture?: string | null,
      coverPicture?: string | null,
      description?: string | null,
      location?: string | null,
      isBlueVerified?: boolean,
      isGovernmentVerified?: boolean,
      favouritesCount?: number,
      statusesCount?: number,
      mediaCount?: number,
      createdAt?: string,
      isProtected?: boolean,
      isSuspended?: boolean,
      isUnavailable?: boolean,
      pinnedTweetIds?: string[],
      website?: string | null
    },
    createdAt?: string,
    likeCount?: number,
    retweetCount?: number,
    replyCount?: number,
    quoteCount?: number,
    viewCount?: number | null,
    bookmarkCount?: number,
    lang?: string,
    source?: string,
    isRetweet?: boolean,
    isQuote?: boolean,
    isPinned?: boolean,
    inReplyToStatusId?: string | null,
    inReplyToUserId?: string | null,
    quotedTweetId?: string | null,
    media?: {
      type?: string,
      url?: string,
      mediaUrlHttps?: string,
      expandedUrl?: string,
      width?: number,
      height?: number,
      altText?: string | null,
      durationMs?: number | null
    }[],
    entities?: {
      urls?: {
        url?: string,
        expandedUrl?: string,
        displayUrl?: string
      }[],
      hashtags?: {
        text?: string
      }[],
      userMentions?: {
        id?: string,
        name?: string,
        screenName?: string
      }[]
    },
    conversationId?: string
  },
  user?: {
    id: string,
    userName: string,
    name: string,
    followerCount?: number,
    followingCount?: number,
    profilePicture?: string | null,
    coverPicture?: string | null,
    description?: string | null,
    location?: string | null,
    isBlueVerified?: boolean,
    isGovernmentVerified?: boolean,
    favouritesCount?: number,
    statusesCount?: number,
    mediaCount?: number,
    createdAt?: string,
    isProtected?: boolean,
    isSuspended?: boolean,
    isUnavailable?: boolean,
    pinnedTweetIds?: string[],
    website?: string | null
  },
  matchedRules?: {
    id?: string,
    tag?: string,
    value?: string
  }[]
}

Response data full type

{
  type: tweet.filter_match,
  data: {
    tweet: {
      id: string,
      text: string,
      author?: {
        id: string,
        userName: string,
        name: string,
        followerCount?: number,
        followingCount?: number,
        profilePicture?: string | null,
        coverPicture?: string | null,
        description?: string | null,
        location?: string | null,
        isBlueVerified?: boolean,
        isGovernmentVerified?: boolean,
        favouritesCount?: number,
        statusesCount?: number,
        mediaCount?: number,
        createdAt?: string,
        isProtected?: boolean,
        isSuspended?: boolean,
        isUnavailable?: boolean,
        pinnedTweetIds?: string[],
        website?: string | null
      },
      createdAt?: string,
      likeCount?: number,
      retweetCount?: number,
      replyCount?: number,
      quoteCount?: number,
      viewCount?: number | null,
      bookmarkCount?: number,
      lang?: string,
      source?: string,
      isRetweet?: boolean,
      isQuote?: boolean,
      isPinned?: boolean,
      inReplyToStatusId?: string | null,
      inReplyToUserId?: string | null,
      quotedTweetId?: string | null,
      media?: {
        type?: string,
        url?: string,
        mediaUrlHttps?: string,
        expandedUrl?: string,
        width?: number,
        height?: number,
        altText?: string | null,
        durationMs?: number | null
      }[],
      entities?: {
        urls?: {
          url?: string,
          expandedUrl?: string,
          displayUrl?: string
        }[],
        hashtags?: {
          text?: string
        }[],
        userMentions?: {
          id?: string,
          name?: string,
          screenName?: string
        }[]
      },
      conversationId?: string
    },
    user?: {
      id: string,
      userName: string,
      name: string,
      followerCount?: number,
      followingCount?: number,
      profilePicture?: string | null,
      coverPicture?: string | null,
      description?: string | null,
      location?: string | null,
      isBlueVerified?: boolean,
      isGovernmentVerified?: boolean,
      favouritesCount?: number,
      statusesCount?: number,
      mediaCount?: number,
      createdAt?: string,
      isProtected?: boolean,
      isSuspended?: boolean,
      isUnavailable?: boolean,
      pinnedTweetIds?: string[],
      website?: string | null
    },
    matchedRules?: {
      id?: string,
      tag?: string,
      value?: string
    }[]
  },
  timestamp?: string
}

webhookHooks example

twitterapiio({
    webhookHooks: {
        tweets: {
            filterMatch: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Tweets

​Created

​Filter Match

Webhook map

HTTP handler setup

Events

Tweets

Created

Filter Match