ChannelPayload interface

Payload delivered on a table's notification channel by the installed trigger, describing a single row change.

Signature:

export interface ChannelPayload 

Properties

Property

Modifiers

Type

Description

operation

ChannelOperation

Which row-level operation fired the trigger.

record

JsonObject

The changed row. NEW for inserts and updates, OLD for deletes, so this is always the row the change is about.

schema

string

PostgreSQL schema of the changed table.

table

string

Name of the changed table — also the notification channel name.

timestamp

Date

When the change occurred. Arrives JSON-encoded and is revived into a Date before a ChannelPayloadFilter sees it.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.