• Polling: Periodically call endpoints to check for changes.
• Webhooks: Listen to user events through a single URL.
• App Webhooks (Subscriptions): Use a developer app (using OAuth2) to receive all authorized user events at a single URL (Not Supported).

npm run cli triggers create

1. Piece Folder Name: This is the name associated with the folder where the trigger resides. It helps organize and categorize triggers within the piece.
2. Trigger Display Name: The name users see in the interface, conveying the trigger’s purpose clearly.
3. Trigger Description: A brief, informative text in the UI, guiding users about the trigger’s function and purpose.
4. Trigger Technique: Specifies the trigger type - either polling or webhook.

​

Trigger Structure

export const createNewIssue = createTrigger({
    auth: PieceAuth | undefined
    name: string, // Unique name across the piece.
    displayName: string, // Display name on the interface.
	description: string, // Description for the action
    sampleData: null,
    type: TriggerStrategy.WEBHOOK | TriggerStrategy.POLLING | TriggerStrategy.APP_WEBHOOK,

    props: {}; // Required properties from the user.
    // Set up the trigger. See "When the hooks run" below.
	onEnable: (ctx) => {},
    // Tear the trigger down. See "When the hooks run" below.
	onDisable: (ctx) => {},

    // Trigger implementation, It takes context as parameter.
    // should returns an array of payload, each payload considered
    run: async run(ctx): unknown[] => {}
})

​

When the hooks run

• A failing onDisable is logged and ignored, so the flow still turns off. A failing onEnable fails the publish or the turn-on.
• A patch upgrade in the builder (e.g. 0.5.1 → 0.5.3) keeps the trigger’s inputs. A minor or major upgrade resets them to the new version’s defaults. Which row applies depends on the inputs that get published: if they match the running flow, context.isRepublish is still true; if they differ, the trigger starts fresh. Don’t rely on an upgrade to clear stored state.
• context.isRepublish is true only in the rows that say so. Use it to keep stored state that is still valid, rather than starting fresh. See Polling Trigger → Republishing a running flow.
• A polling trigger’s onDisable still runs when the flow is turned off or deleted, but not on an upgrade, because the trigger keeps running. If onEnable creates something outside the store, save its id in the store and, when context.isRepublish is true and the id exists, reuse it instead of creating another. If the trigger needs to register and unregister with every version, make it a webhook trigger: those run both hooks on every republish.
• test runs when the user loads sample data in the builder, and run runs on every poll or incoming event. Neither is part of turning the flow on or off.

​

Context Object

// Store: A simple, lightweight key-value store that is helpful when you are developing triggers that persist between runs, used to store information like the last polling date.
await context.store.put('_lastFetchedDate', new Date());
const lastFetchedData = await context.store.get('_lastFetchedDate', new Date());

// Webhook URL: A unique, auto-generated URL that will trigger the flow. Useful when you need to develop a trigger based on webhooks.
context.webhookUrl;

// Payload: Contains information about the HTTP request sent by the third party. It has three properties: status, headers, and body.
context.payload;

// PropsValue: Contains the information filled by the user in defined properties.
context.propsValue;