Webhooks - Corsair

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

application
- submit (application.submit)
- update (application.update)
candidate
- hire (candidate.hire)
- stageChange (candidate.stageChange)
interview
- planTransition (interview.planTransition)
- scheduleCreate (interview.scheduleCreate)
- scheduleUpdate (interview.scheduleUpdate)
offer
- create (offer.create)
- delete (offer.delete)
- update (offer.update)

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

Application

Submit

application.submit Triggered when a candidate application is submitted Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`applicationSubmit`	Yes	—
`data`	`object`	Yes	—

data full type

{
  applicationId?: string,
  candidateId?: string,
  jobId?: string
}

Response data full type

{
  webhookActionId: string,
  action: applicationSubmit,
  data: {
    applicationId?: string,
    candidateId?: string,
    jobId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        application: {
            submit: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Update

application.update Triggered when an application is updated Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`applicationUpdate`	Yes	—
`data`	`object`	Yes	—

data full type

{
  applicationId?: string,
  candidateId?: string,
  jobId?: string,
  status?: string
}

Response data full type

{
  webhookActionId: string,
  action: applicationUpdate,
  data: {
    applicationId?: string,
    candidateId?: string,
    jobId?: string,
    status?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        application: {
            update: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Candidate

Hire

candidate.hire Triggered when a candidate is hired Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`candidateHire`	Yes	—
`data`	`object`	Yes	—

data full type

{
  candidateId?: string,
  applicationId?: string,
  offerId?: string
}

Response data full type

{
  webhookActionId: string,
  action: candidateHire,
  data: {
    candidateId?: string,
    applicationId?: string,
    offerId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        candidate: {
            hire: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Stage Change

candidate.stageChange Triggered when a candidate moves to a different interview stage Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`candidateStageChange`	Yes	—
`data`	`object`	Yes	—

data full type

{
  candidateId?: string,
  applicationId?: string,
  jobId?: string,
  previousInterviewStageId?: string | null,
  currentInterviewStageId?: string
}

Response data full type

{
  webhookActionId: string,
  action: candidateStageChange,
  data: {
    candidateId?: string,
    applicationId?: string,
    jobId?: string,
    previousInterviewStageId?: string | null,
    currentInterviewStageId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        candidate: {
            stageChange: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Interview

Plan Transition

interview.planTransition Triggered during interview plan transitions Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`interviewPlanTransition`	Yes	—
`data`	`object`	Yes	—

data full type

{
  applicationId?: string,
  interviewPlanId?: string
}

Response data full type

{
  webhookActionId: string,
  action: interviewPlanTransition,
  data: {
    applicationId?: string,
    interviewPlanId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        interview: {
            planTransition: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Schedule Create

interview.scheduleCreate Triggered when an interview schedule is created Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`interviewScheduleCreate`	Yes	—
`data`	`object`	Yes	—

data full type

{
  interviewScheduleId?: string,
  applicationId?: string
}

Response data full type

{
  webhookActionId: string,
  action: interviewScheduleCreate,
  data: {
    interviewScheduleId?: string,
    applicationId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        interview: {
            scheduleCreate: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Schedule Update

interview.scheduleUpdate Triggered when an interview schedule is updated Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`interviewScheduleUpdate`	Yes	—
`data`	`object`	Yes	—

data full type

{
  interviewScheduleId?: string,
  applicationId?: string,
  status?: string
}

Response data full type

{
  webhookActionId: string,
  action: interviewScheduleUpdate,
  data: {
    interviewScheduleId?: string,
    applicationId?: string,
    status?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        interview: {
            scheduleUpdate: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Offer

Create

offer.create Triggered when a job offer is created Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`offerCreate`	Yes	—
`data`	`object`	Yes	—

data full type

{
  offerId?: string,
  applicationId?: string
}

Response data full type

{
  webhookActionId: string,
  action: offerCreate,
  data: {
    offerId?: string,
    applicationId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        offer: {
            create: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Delete

offer.delete Triggered when a job offer is deleted Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`offerDelete`	Yes	—
`data`	`object`	Yes	—

data full type

{
  offerId?: string,
  applicationId?: string
}

Response data full type

{
  webhookActionId: string,
  action: offerDelete,
  data: {
    offerId?: string,
    applicationId?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        offer: {
            delete: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Update

offer.update Triggered when a job offer is updated Payload

Name	Type	Required	Description
`webhookActionId`	`string`	Yes	—
`action`	`offerUpdate`	Yes	—
`data`	`object`	Yes	—

data full type

{
  offerId?: string,
  applicationId?: string,
  status?: string
}

Response data full type

{
  webhookActionId: string,
  action: offerUpdate,
  data: {
    offerId?: string,
    applicationId?: string,
    status?: string
  }
}

webhookHooks example

ashby({
    webhookHooks: {
        offer: {
            update: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Application

​Submit

​Update

​Candidate

​Hire

​Stage Change

​Interview

​Plan Transition

​Schedule Create

​Schedule Update

​Offer

​Create

​Delete

​Update

Webhook map

HTTP handler setup

Events

Application

Submit

Update

Candidate

Hire

Stage Change

Interview

Plan Transition

Schedule Create

Schedule Update

Offer

Create

Delete

Update