Webhooks - Corsair

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

notifications
- newPayment (notifications.newPayment)
- ping (notifications.ping)

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

Notifications

New Payment

notifications.newPayment A new on-chain payment arrived at a watched address Payload

Name	Type	Required	Description
`id`	`string`	No	—
`type`	`wallet:addresses:new-payment`	Yes	—
`data`	`object`	No	—
`user`	`object`	No	—
`account`	`object`	No	—
`delivery_attempts`	`number`	No	—
`created_at`	`string`	No	—
`resource`	`string`	No	—
`resource_path`	`string`	No	—

data full type

{
}

user full type

{
  id?: string,
  resource?: string,
  resource_path?: string
}

account full type

{
  id?: string,
  resource?: string,
  resource_path?: string
}

Response data full type

{
  id?: string,
  type: wallet:addresses:new-payment,
  data?: {
  },
  user?: {
    id?: string,
    resource?: string,
    resource_path?: string
  },
  account?: {
    id?: string,
    resource?: string,
    resource_path?: string
  },
  delivery_attempts?: number,
  created_at?: string,
  resource?: string,
  resource_path?: string
}

webhookHooks example

coinbase({
    webhookHooks: {
        notifications: {
            newPayment: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Ping

notifications.ping Coinbase webhook ping used to verify a notification URL Payload

Name	Type	Required	Description
`id`	`string`	No	—
`type`	`ping`	Yes	—
`data`	`object`	No	—
`user`	`object`	No	—
`account`	`object`	No	—
`delivery_attempts`	`number`	No	—
`created_at`	`string`	No	—
`resource`	`string`	No	—
`resource_path`	`string`	No	—

data full type

{
}

user full type

{
  id?: string,
  resource?: string,
  resource_path?: string
}

account full type

{
  id?: string,
  resource?: string,
  resource_path?: string
}

Response data full type

{
  id?: string,
  type: ping,
  data?: {
  },
  user?: {
    id?: string,
    resource?: string,
    resource_path?: string
  },
  account?: {
    id?: string,
    resource?: string,
    resource_path?: string
  },
  delivery_attempts?: number,
  created_at?: string,
  resource?: string,
  resource_path?: string
}

webhookHooks example

coinbase({
    webhookHooks: {
        notifications: {
            ping: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Notifications

​New Payment

​Ping

Webhook map

HTTP handler setup

Events

Notifications

New Payment

Ping