On release note event - Automate.ax

linear.onReleaseNoteEvent handles release note changes in the connected Linear workspace.

automations/watch-linear-release-note.automation.ts

import { automation } from "automate.ax"
import { linear } from "automate.ax/linear"

export default automation("On release note event", () => {
  const event = linear.onReleaseNoteEvent()
  // Route the Linear release note event by action.
})

Optional static account defaults to the project binding. Linear webhook triggers require an OAuth connection with read access. The workspace can’t change at runtime.

Trigger data

Returns a Signal<LinearReleaseNoteTrigger>:

type LinearReleaseNoteTrigger = LinearReleaseNote & {
  event: LinearWebhookEvent<LinearReleaseNote, "create" | "update" | "remove">
}

interface LinearReleaseNote {
  archivedAt?: string | null
  content?: string | null
  createdAt: string
  id: string
  pipelineId: string
  releaseIds: string[]
  slugId: string
  title?: string | null
  updatedAt: string
  url: string
}

interface LinearWebhookEvent<TData, TAction extends string> {
  action: TAction
  actor?: LinearActor | null
  createdAt: string
  data: TData
  organizationId: string
  type: "ReleaseNote"
  updatedFrom?: Record<string, JSONValue> | null
  url?: string | null
  webhookId: string
  webhookTimestamp: number
}

interface LinearActor {
  email?: string
  id?: string
  name?: string
  type?: string
  url?: string
}

Release notes can span several releases. releaseIds contains every linked release. Resource objects and the webhook envelope retain extra Linear fields.