Webhooks - Corsair

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

alerts
- eventAlert (alerts.eventAlert)
- metricAlert (alerts.metricAlert)
comments
- created (comments.created)
- deleted (comments.deleted)
- updated (comments.updated)
errors
- created (errors.created)
issues
- assigned (issues.assigned)
- created (issues.created)
- resolved (issues.resolved)

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

Alerts

Event Alert

alerts.eventAlert An issue alert rule was triggered Payload

Name	Type	Required	Description
`action`	`triggered`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	No	—
`installation`	`object`	No	—

data full type

{
  event: {
    event_id?: string,
    title?: string,
    message?: string,
    platform?: string | null,
    level?: string | null,
    url?: string
  },
  triggered_rule?: string
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: triggered,
  data: {
    event: {
      event_id?: string,
      title?: string,
      message?: string,
      platform?: string | null,
      level?: string | null,
      url?: string
    },
    triggered_rule?: string
  },
  actor?: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        alerts: {
            eventAlert: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Metric Alert

alerts.metricAlert A metric alert was triggered Payload

Name	Type	Required	Description
`action`	`triggered`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	No	—
`installation`	`object`	No	—

data full type

{
  metric_alert: {
    id?: string,
    title?: string,
    alert_rule?: {
      id?: number,
      name?: string
    },
    status?: string,
    date_triggered?: string
  },
  description_title?: string,
  description_text?: string
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: triggered,
  data: {
    metric_alert: {
      id?: string,
      title?: string,
      alert_rule?: {
        id?: number,
        name?: string
      },
      status?: string,
      date_triggered?: string
    },
    description_title?: string,
    description_text?: string
  },
  actor?: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        alerts: {
            metricAlert: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Comments

Created

comments.created A comment was added to an issue Payload

Name	Type	Required	Description
`action`	`created`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	Yes	—
`installation`	`object`	No	—

data full type

{
  comment_id?: string,
  issue_id?: string,
  project_slug?: string,
  comment?: string,
  timestamp?: string
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: created,
  data: {
    comment_id?: string,
    issue_id?: string,
    project_slug?: string,
    comment?: string,
    timestamp?: string
  },
  actor: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        comments: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Deleted

comments.deleted A comment was deleted Payload

Name	Type	Required	Description
`action`	`deleted`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	Yes	—
`installation`	`object`	No	—

data full type

{
  comment_id?: string,
  issue_id?: string,
  project_slug?: string,
  comment?: string,
  timestamp?: string
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: deleted,
  data: {
    comment_id?: string,
    issue_id?: string,
    project_slug?: string,
    comment?: string,
    timestamp?: string
  },
  actor: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        comments: {
            deleted: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Updated

comments.updated A comment was updated Payload

Name	Type	Required	Description
`action`	`updated`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	Yes	—
`installation`	`object`	No	—

data full type

{
  comment_id?: string,
  issue_id?: string,
  project_slug?: string,
  comment?: string,
  timestamp?: string
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: updated,
  data: {
    comment_id?: string,
    issue_id?: string,
    project_slug?: string,
    comment?: string,
    timestamp?: string
  },
  actor: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        comments: {
            updated: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Errors

Created

errors.created A new error event was captured in Sentry Payload

Name	Type	Required	Description
`action`	`created`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	No	—
`installation`	`object`	No	—

data full type

{
  error: {
    event_id?: string,
    title?: string,
    platform?: string | null,
    level?: string | null,
    url?: string,
    culprit?: string | null,
    project?: string | null,
    message?: string | null
  }
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: created,
  data: {
    error: {
      event_id?: string,
      title?: string,
      platform?: string | null,
      level?: string | null,
      url?: string,
      culprit?: string | null,
      project?: string | null,
      message?: string | null
    }
  },
  actor?: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        errors: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Issues

Assigned

issues.assigned An issue was assigned to a user or team Payload

Name	Type	Required	Description
`action`	`assigned`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	Yes	—
`installation`	`object`	No	—

data full type

{
  issue: {
    id: string,
    shortId: string,
    title: string,
    culprit?: string | null,
    level?: string | null,
    status: string,
    platform?: string | null,
    type?: string | null,
    permalink?: string | null,
    firstSeen?: string | null,
    lastSeen?: string | null,
    assignedTo?: {
      id?: string,
      name?: string,
      type?: string
    } | null
  }
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: assigned,
  data: {
    issue: {
      id: string,
      shortId: string,
      title: string,
      culprit?: string | null,
      level?: string | null,
      status: string,
      platform?: string | null,
      type?: string | null,
      permalink?: string | null,
      firstSeen?: string | null,
      lastSeen?: string | null,
      assignedTo?: {
        id?: string,
        name?: string,
        type?: string
      } | null
    }
  },
  actor: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        issues: {
            assigned: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Created

issues.created A new issue was created in Sentry Payload

Name	Type	Required	Description
`action`	`created`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	Yes	—
`installation`	`object`	No	—

data full type

{
  issue: {
    id: string,
    shortId: string,
    title: string,
    culprit?: string | null,
    level?: string | null,
    status: string,
    platform?: string | null,
    type?: string | null,
    permalink?: string | null,
    firstSeen?: string | null,
    lastSeen?: string | null
  }
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: created,
  data: {
    issue: {
      id: string,
      shortId: string,
      title: string,
      culprit?: string | null,
      level?: string | null,
      status: string,
      platform?: string | null,
      type?: string | null,
      permalink?: string | null,
      firstSeen?: string | null,
      lastSeen?: string | null
    }
  },
  actor: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        issues: {
            created: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

Resolved

issues.resolved An issue was resolved Payload

Name	Type	Required	Description
`action`	`resolved`	Yes	—
`data`	`object`	Yes	—
`actor`	`object`	Yes	—
`installation`	`object`	No	—

data full type

{
  issue: {
    id: string,
    shortId: string,
    title: string,
    culprit?: string | null,
    level?: string | null,
    status: string,
    platform?: string | null,
    type?: string | null,
    permalink?: string | null,
    firstSeen?: string | null,
    lastSeen?: string | null
  },
  resolution_type?: string
}

actor full type

{
  type: string,
  id?: number,
  name?: string
}

installation full type

{
  uuid: string
}

Response data full type

{
  action: resolved,
  data: {
    issue: {
      id: string,
      shortId: string,
      title: string,
      culprit?: string | null,
      level?: string | null,
      status: string,
      platform?: string | null,
      type?: string | null,
      permalink?: string | null,
      firstSeen?: string | null,
      lastSeen?: string | null
    },
    resolution_type?: string
  },
  actor: {
    type: string,
    id?: number,
    name?: string
  },
  installation?: {
    uuid: string
  }
}

webhookHooks example

sentry({
    webhookHooks: {
        issues: {
            resolved: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Alerts

​Event Alert

​Metric Alert

​Comments

​Created

​Deleted

​Updated

​Errors

​Created

​Issues

​Assigned

​Created

​Resolved

Webhook map

HTTP handler setup

Events

Alerts

Event Alert

Metric Alert

Comments

Created

Deleted

Updated

Errors

Created

Issues

Assigned

Created

Resolved