@marceloclp/monzojs/lib/endpoints/webhooks.d.ts

Unofficial wrapper for the Monzo API written in TypeScript.

import { Monzo, MonzoAPI } from '../types';
import { AuthedEndpoint } from '../types/endpoints';
/**
 * List the webhooks your application has registered on an account.
 *
 * @see https://docs.monzo.com/#list-webhooks
 */
export declare const getWebhooks: AuthedEndpoint<MonzoAPI.Webhooks.GetWebhookParams, Monzo.Webhook[]>;
/**
 * Register a webhook.
 *
 * Each time a matching event occurs, Monzo will make a POST call to the URL you
 * provide. If the call fails, we will retry up to a maximum of 5 attempts, with
 * exponential backoff.
 *
 * @see https://docs.monzo.com/#registering-a-webhook
 */
export declare const createWebhook: AuthedEndpoint<MonzoAPI.Webhooks.CreateWebhookParams, Monzo.Webhook>;
/**
 * Delete a webhook.
 *
 * This will stop Monzo from sending notifications to the webhook's url.
 *
 * @see https://docs.monzo.com/#deleting-a-webhook
 */
export declare const deleteWebhook: AuthedEndpoint<MonzoAPI.Webhooks.DeleteWebhookParams, {}>;