Interface AppWebhookInterface

AppWebhook entity interface

Mirrors macs-node-sdk/lib/app/models/app-webhook.js. Note the field is singular event, not events[] — the schema only supports a single event per webhook today.

interface AppWebhookInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    app: string;
    org?: string;
    user?: string;
    agent?: string;
    url: string;
    event?: "REQUEST";
    headers?: string;
    tags?: string[];
    active?: boolean;
}

Hierarchy (View Summary)

Properties

external_id? extensors? record_history? id? app org? user? agent? url event? headers? tags? active?

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

app

app: string

App this webhook belongs to (required)

Optionalorg

org?: string

Optionaluser

user?: string

Optionalagent

agent?: string

url

url: string

Callback URL the app invokes (required)

Optionalevent

event?: "REQUEST"

Event name that triggers the webhook (singular)

Optionalheaders

headers?: string

Raw HTTP headers to forward (string form)

Optionaltags

tags?: string[]

Optionalactive

active?: boolean

Whether the entity is active

Settings

Member Visibility

On This Page

Properties