add webhook naming via sdk (alchemyplatform#492)

* add webhook naming via sdk

* addressing comments

Author: GregoryElliott

src/api/notify-namespace.ts

@@ -519,6 +519,7 @@ export class NotifyNamespace {
       webhook_type: type,
       webhook_url: url,
       ...(appId && { app_id: appId }),
+      ...(params.name && { name: params.name }),
 
       // Only include the filters/addresses in the final response if they're defined
       ...nftFilterObj,
@@ -667,7 +668,9 @@ function parseRawWebhook(rawWebhook: RawWebhook): Webhook {
     signingKey: rawWebhook.signing_key,
     version: rawWebhook.version as WebhookVersion,
     // Only include the appId in the final response if it's defined
-    ...(rawWebhook.app_id !== undefined && { appId: rawWebhook.app_id })
+    ...(rawWebhook.app_id !== undefined && { appId: rawWebhook.app_id }),
+    // Only include the name in the final response if it's defined
+    ...(rawWebhook.name !== undefined && { name: rawWebhook.name })
   };
 }
 

src/internal/raw-interfaces.ts

@@ -255,6 +255,7 @@ export interface RawWebhook {
   signing_key: string;
   version: string;
   app_id?: string;
+  name?: string;
 }
 
 export interface RawWebhookPagination {

src/types/types.ts

@@ -6,6 +6,7 @@ import {
 import { BigNumberish } from '@ethersproject/bignumber';
 import { ConnectionInfo } from '@ethersproject/web';
 
+import { NotifyNamespace } from '../api/notify-namespace';
 import {
   ERC1155Metadata,
   NftRefreshState,
@@ -1129,6 +1130,8 @@ export interface Webhook {
    * {@link MinedTransactionWebhook} and {@link DroppedTransactionWebhook}
    */
   appId?: string;
+  /** The name of the webhook. */
+  name?: string;
 }
 
 /** The version of the webhook. All newly created webhooks default to V2. */
@@ -1235,6 +1238,14 @@ export interface CustomGraphqlWebhookConfig {
   graphqlQuery: string;
 }
 
+/**
+ * Base interface for all webhook parameters that includes common fields.
+ */
+export interface BaseWebhookParams {
+  /** Optional name for the webhook. */
+  name?: string;
+}
+
 /**
  * Params to pass in when calling {@link NotifyNamespace.createWebhook} in order
  * to create a {@link MinedTransactionWebhook} or {@link DroppedTransactionWebhook}.
@@ -1246,7 +1257,7 @@ export interface CustomGraphqlWebhookConfig {
  * This is a temporary workaround for now. We're planning on detecting the app
  * id from the provided api key directly. Stay tuned!
  */
-export interface TransactionWebhookParams {
+export interface TransactionWebhookParams extends BaseWebhookParams {
   /** The app id of the project to create the webhook on. */
   appId: string;
 }
@@ -1255,7 +1266,7 @@ export interface TransactionWebhookParams {
  * Params to pass in when calling {@link NotifyNamespace.createWebhook} in order
  * to create a {@link NftActivityWebhook} or {@link NftMetadataUpdateWebhook}.
  */
-export interface NftWebhookParams {
+export interface NftWebhookParams extends BaseWebhookParams {
   /** Array of NFT filters the webhook should track. */
   filters: NftFilter[];
   /**
@@ -1269,7 +1280,7 @@ export interface NftWebhookParams {
  * Params to pass in when calling {@link NotifyNamespace.createWebhook} in order
  * to create a {@link CustomGraphqlWebhook}
  */
-export interface CustomGraphqlWebhookParams {
+export interface CustomGraphqlWebhookParams extends BaseWebhookParams {
   /** GraphQL query */
   graphqlQuery: string;
   /**
@@ -1302,7 +1313,7 @@ export interface CustomGraphqlWebhookParams {
  * Params to pass in when calling {@link NotifyNamespace.createWebhook} in order
  * to create a {@link AddressActivityWebhook}.
  */
-export interface AddressWebhookParams {
+export interface AddressWebhookParams extends BaseWebhookParams {
   /** Array of addresses the webhook should activity for. */
   addresses: string[];
   /**