@makehq/sdk
    Preparing search index...

    Type Alias Hook

    Represents a Make webhook or mailhook. Hooks notify you whenever a certain change occurs in the connected app or service, such as sending an HTTP request or an email.

    type Hook = {
        data: Record<string, JSONValue>;
        editable: boolean;
        enabled: boolean;
        gone: boolean;
        id: number;
        name: string;
        packageName: string | null;
        queueCount: number;
        queueLimit: number;
        scenarioId?: number;
        teamId: number;
        theme: string;
        type: "web" | "web-shared" | "mail";
        typeName: string;
        udid: string;
        url?: string;
    }
    Index

    Properties

    data editable enabled gone id name packageName queueCount queueLimit scenarioId? teamId theme type typeName udid url?

    Properties

    data: Record<string, JSONValue>

    Additional data specific to the hook type

    editable: boolean

    Whether the hook can be edited

    enabled: boolean

    Whether the hook is enabled

    gone: boolean

    Whether the hook is no longer accessible

    id: number

    Unique identifier of the hook

    name: string

    Name of the hook

    packageName: string | null

    Name of the app this hook is for

    queueCount: number

    Current number of items in the hook's queue

    queueLimit: number

    Maximum number of items allowed in the queue

    scenarioId?: number

    ID of the scenario associated with this hook, if any

    teamId: number

    ID of the team that owns the hook

    theme: string

    Theme color for the hook in UI

    type: "web" | "web-shared" | "mail"

    Type of hook (web, web-shared, or mail)

    typeName: string

    The hook type name related to the app for which it was created

    udid: string

    Unique identifier used in webhook URLs

    url?: string

    The webhook URL that receives callbacks

    Settings

    Member Visibility

    On This Page

    Properties