pluggy-sdk/dist/types/webhook.d.ts

Official Node SDK for Pluggy API.

import { TriggeredBy } from './execution';
export declare const WEBHOOK_EVENTS: readonly ["item/created", "item/updated", "item/error", "item/deleted", "item/waiting_user_input", "item/waiting_user_action", "item/login_succeeded", "connector/status_updated", "transactions/created", "transactions/updated", "transactions/deleted", "payment_intent/created", "payment_intent/completed", "payment_intent/waiting_payer_authorization", "payment_intent/error", "scheduled_payment/created", "scheduled_payment/completed", "scheduled_payment/error", "scheduled_payment/canceled", "scheduled_payment/all_completed", "scheduled_payment/all_created", "payment_refund/completed", "payment_refund/error", "boleto/updated", "all"];
/**
 * @typedef WebhookEvent
 * Type of events that can be subscribed
 */
export declare type WebhookEvent = typeof WEBHOOK_EVENTS[number];
export declare type Webhook = {
    /** Primary identifier of the entity */
    id: string;
    /** Url where notifications of events will be sent */
    url: string;
    /** Type of event subscribed */
    event: WebhookEvent;
    /** Time of the creation of the webhook */
    createdAt: Date;
    /** Time of last time the webhook was updated
     * (note: if it was never updated it will be equal to createdAt) */
    updatedAt: Date;
    /** Time of when the webhook was disabled */
    disabledAt: Date | null;
};
export declare type CreateWebhook = {
    /** Type of event subscribed */
    event: WebhookEvent;
    /** Url where notifications of events will be sent */
    url: string;
    /** Object to specify headers in your webhook notifications */
    headers?: Record<string, string> | null;
};
export declare type UpdateWebhook = Partial<CreateWebhook> & {
    /** Boolean to enable or disable the webhook */
    enabled?: boolean;
};
export declare type WebhookEventPayload = {
    /** @deprecated id of the entity related to the event (use eventId to uniquely identify a webhook event)*/
    id: string;
    /** Primary identifier of the event that was notified */
    eventId: string;
} & ({
    /** Type of event subscribed */
    event: 'item/created' | 'item/updated' | 'item/waiting_user_input' | 'item/login_succeeded' | 'item/deleted';
    /** Primary identifier of the item related to the event */
    itemId: string;
    /** Who trigger the event */
    triggeredBy?: TriggeredBy | null;
} | {
    /** Type of event subscribed */
    event: 'item/error';
    /** Primary identifier of the item related to the event */
    itemId: string;
    /** Object related to item/error event */
    error: {
        code: string;
        message: string;
    };
    /** Who trigger the event */
    triggeredBy?: TriggeredBy | null;
} | {
    /** Type of event subscribed */
    event: 'connector/status_updated';
    /** Object with extra information of the connector updated */
    data: {
        status: string;
    };
} | {
    /** Type of event subscribed */
    event: 'transactions/deleted' | 'transactions/updated';
    /** Primary identifier of the item related to the event */
    itemId: string;
    /** Primary identifier of the client related to the event */
    clientId: string;
    /** Primary identifier of the account related to the event */
    accountId: string;
    /** Primary identifier of the transactions related to the event */
    transactionIds: string[];
} | {
    event: 'transactions/created';
    /** Primary identifier of the item related to the event */
    itemId: string;
    /** Primary identifier of the account related to the event */
    accountId: string;
    /** Filter transactions created after date. Format is ISO Date. */
    transactionsCreatedAtFrom: string;
    /** Link to get the created transactions of the sync */
    createdTransactionsLink: string;
} | {
    event: 'payment_intent/created' | 'payment_intent/completed' | 'payment_intent/error';
    paymentIntentId: string;
    paymentRequestId: string;
} | {
    event: 'scheduled_payment/created' | 'scheduled_payment/completed' | 'scheduled_payment/error' | 'scheduled_payment/canceled';
    paymentRequestId: string;
    scheduledPaymentId: string;
});