Class AlchemyNotifyClient

constructor

• new AlchemyNotifyClient(): AlchemyNotifyClient

  Returns AlchemyNotifyClient

Staticinstance

createWebhook

• createWebhook(
      __namedParameters: {
          addresses: string[];
          network:
              | "ABSTRACT_MAINNET"
              | "ABSTRACT_TESTNET"
              | "ANIME_MAINNET"
              | "ANIME_SEPOLIA"
              | "APECHAIN_CURTIS"
              | "APECHAIN_MAINNET"
              | "ARB_MAINNET"
              | "ARB_SEPOLIA"
              | "ARC_MAINNET"
              | "ARC_TESTNET"
              | "AVAX_FUJI"
              | "AVAX_MAINNET"
              | "BASE_MAINNET"
              | "BASE_SEPOLIA"
              | "BERACHAIN_BEPOLIA"
              | "BERACHAIN_MAINNET"
              | "BLAST_MAINNET"
              | "BLAST_SEPOLIA"
              | "BNB_MAINNET"
              | "BNB_TESTNET"
              | "CELO_MAINNET"
              | "CELO_SEPOLIA"
              | "ETH_MAINNET"
              | "ETH_SEPOLIA"
              | "GENSYN_TESTNET"
              | "GNOSIS_CHIADO"
              | "GNOSIS_MAINNET"
              | "HYPERLIQUID_MAINNET"
              | "INK_MAINNET"
              | "INK_SEPOLIA"
              | "LINEA_MAINNET"
              | "LINEA_SEPOLIA"
              | "MANTLE_MAINNET"
              | "MANTLE_SEPOLIA"
              | "MATIC_AMOY"
              | "MATIC_MAINNET"
              | "METIS_MAINNET"
              | "MONAD_MAINNET"
              | "MONAD_TESTNET"
              | "OPT_MAINNET"
              | "OPT_SEPOLIA"
              | "PLASMA_MAINNET"
              | "ROBINHOOD_MAINNET"
              | "ROBINHOOD_TESTNET"
              | "RONIN_MAINNET"
              | "RONIN_SAIGON"
              | "SCROLL_MAINNET"
              | "SETTLUS_MAINNET"
              | "SETTLUS_SEPTESTNET"
              | "SHAPE_MAINNET"
              | "SHAPE_SEPOLIA"
              | "SOLANA_DEVNET"
              | "SOLANA_MAINNET"
              | "SONEIUM_MAINNET"
              | "SONEIUM_MINATO"
              | "SONIC_MAINNET"
              | "STARKNET_MAINNET"
              | "STARKNET_SEPOLIA"
              | "STELLAR_MAINNET"
              | "STELLAR_TESTNET"
              | "UNICHAIN_MAINNET"
              | "UNICHAIN_SEPOLIA"
              | "WORLDCHAIN_MAINNET"
              | "WORLDCHAIN_SEPOLIA"
              | "ZETACHAIN_MAINNET"
              | "ZETACHAIN_TESTNET"
              | "ZKSYNC_MAINNET"
              | "ZKSYNC_SEPOLIA"
              | "ZORA_MAINNET"
              | "ZORA_SEPOLIA";
          url: string;
      },
  ): Promise<{ error: AlchemyError; ok: false } | { ok: true; value: T }>

  An address activity webhook posting to url, watching addresses (at most 500).

  Parameters

  • __namedParameters: {
        addresses: string[];
        network:
            | "ABSTRACT_MAINNET"
            | "ABSTRACT_TESTNET"
            | "ANIME_MAINNET"
            | "ANIME_SEPOLIA"
            | "APECHAIN_CURTIS"
            | "APECHAIN_MAINNET"
            | "ARB_MAINNET"
            | "ARB_SEPOLIA"
            | "ARC_MAINNET"
            | "ARC_TESTNET"
            | "AVAX_FUJI"
            | "AVAX_MAINNET"
            | "BASE_MAINNET"
            | "BASE_SEPOLIA"
            | "BERACHAIN_BEPOLIA"
            | "BERACHAIN_MAINNET"
            | "BLAST_MAINNET"
            | "BLAST_SEPOLIA"
            | "BNB_MAINNET"
            | "BNB_TESTNET"
            | "CELO_MAINNET"
            | "CELO_SEPOLIA"
            | "ETH_MAINNET"
            | "ETH_SEPOLIA"
            | "GENSYN_TESTNET"
            | "GNOSIS_CHIADO"
            | "GNOSIS_MAINNET"
            | "HYPERLIQUID_MAINNET"
            | "INK_MAINNET"
            | "INK_SEPOLIA"
            | "LINEA_MAINNET"
            | "LINEA_SEPOLIA"
            | "MANTLE_MAINNET"
            | "MANTLE_SEPOLIA"
            | "MATIC_AMOY"
            | "MATIC_MAINNET"
            | "METIS_MAINNET"
            | "MONAD_MAINNET"
            | "MONAD_TESTNET"
            | "OPT_MAINNET"
            | "OPT_SEPOLIA"
            | "PLASMA_MAINNET"
            | "ROBINHOOD_MAINNET"
            | "ROBINHOOD_TESTNET"
            | "RONIN_MAINNET"
            | "RONIN_SAIGON"
            | "SCROLL_MAINNET"
            | "SETTLUS_MAINNET"
            | "SETTLUS_SEPTESTNET"
            | "SHAPE_MAINNET"
            | "SHAPE_SEPOLIA"
            | "SOLANA_DEVNET"
            | "SOLANA_MAINNET"
            | "SONEIUM_MAINNET"
            | "SONEIUM_MINATO"
            | "SONIC_MAINNET"
            | "STARKNET_MAINNET"
            | "STARKNET_SEPOLIA"
            | "STELLAR_MAINNET"
            | "STELLAR_TESTNET"
            | "UNICHAIN_MAINNET"
            | "UNICHAIN_SEPOLIA"
            | "WORLDCHAIN_MAINNET"
            | "WORLDCHAIN_SEPOLIA"
            | "ZETACHAIN_MAINNET"
            | "ZETACHAIN_TESTNET"
            | "ZKSYNC_MAINNET"
            | "ZKSYNC_SEPOLIA"
            | "ZORA_MAINNET"
            | "ZORA_SEPOLIA";
        url: string;
    }

  Returns Promise<{ error: AlchemyError; ok: false } | { ok: true; value: T }>

deleteWebhook

• deleteWebhook(
      __namedParameters: { webhookId: string },
  ): Promise<
      | { error: AlchemyError
      | WebhookNotFound; ok: false }
      | { ok: true; value: void },
  >

  Parameters

  • __namedParameters: { webhookId: string }

  Returns Promise<
      | { error: AlchemyError
      | WebhookNotFound; ok: false }
      | { ok: true; value: void },
  >

setWebhookActive

• setWebhookActive(
      __namedParameters: { active: boolean; webhookId: string },
  ): Promise<
      | { error: AlchemyError
      | WebhookNotFound; ok: false }
      | { ok: true; value: void },
  >

  Turns a webhook's delivery on or off.

  Parameters

  • __namedParameters: { active: boolean; webhookId: string }

  Returns Promise<
      | { error: AlchemyError
      | WebhookNotFound; ok: false }
      | { ok: true; value: void },
  >

teamWebhooks

• teamWebhooks(): Promise<
      | { ok: true; value: NotifyWebhook[] }
      | { error: AlchemyError; ok: false },
  >

  Every webhook of the team, on any url and network.

  Returns Promise<
      | { ok: true; value: NotifyWebhook[] }
      | { error: AlchemyError; ok: false },
  >

updateWebhookAddresses

• updateWebhookAddresses(
      __namedParameters: {
          add: string[];
          remove: string[];
          webhookId: string;
      },
  ): Promise<
      | { error: AlchemyError
      | WebhookNotFound; ok: false }
      | { ok: true; value: void },
  >

  Adds and removes addresses, at most 500 each; idempotent.

  Parameters

  • __namedParameters: { add: string[]; remove: string[]; webhookId: string }

  Returns Promise<
      | { error: AlchemyError
      | WebhookNotFound; ok: false }
      | { ok: true; value: void },
  >

webhookAddresses

• webhookAddresses(
      __namedParameters: { after?: string; webhookId: string },
  ): Promise<
      | { ok: true; value: { addresses: string[]; after: string
      | null } }
      | { error: AlchemyError | WebhookNotFound; ok: false },
  >

  One page of a webhook's addresses, as Alchemy stores them; after is null after the last.

  Parameters

  • __namedParameters: { after?: string; webhookId: string }

  Returns Promise<
      | { ok: true; value: { addresses: string[]; after: string
      | null } }
      | { error: AlchemyError | WebhookNotFound; ok: false },
  >