feat: add get hook event list

src/client.ts

@@ -106,6 +106,7 @@ import type {
   GetCampaignOptions,
   GetChannelTypeResponse,
   GetCommandResponse,
+  GetHookEventsResponse,
   GetImportResponse,
   GetMessageAPIResponse,
   GetMessageOptions,
@@ -148,6 +149,7 @@ import type {
   PollVote,
   PollVoteData,
   PollVotesAPIResponse,
+  Product,
   PushPreference,
   PushProvider,
   PushProviderConfig,
@@ -2164,6 +2166,17 @@ export class StreamChat {
     });
   }
 
+  /**
+   * getHookEvents - Get available events for hooks (webhook, SQS, and SNS)
+   *
+   * @param {Product[]} [products] Optional array of products to filter events by (e.g., [Product.Chat, Product.Video])
+   * @returns {Promise<GetHookEventsResponse>} Response containing available hook events
+   */
+  async getHookEvents(products?: Product[]) {
+    const params = products && products.length > 0 ? { product: products.join(',') } : {};
+    return await this.get<GetHookEventsResponse>(this.baseURL + '/hook/events', params);
+  }
+
   _addChannelConfig({ cid, config }: ChannelResponse) {
     if (this._cacheEnabled()) {
       this.configs[cid] = config;

src/types.ts

@@ -576,6 +576,23 @@ export type GetRateLimitsResponse = APIResponse & {
   web?: RateLimitsMap;
 };
 
+export enum Product {
+  Chat = 'chat',
+  Video = 'video',
+  Moderation = 'moderation',
+  Feeds = 'feeds',
+}
+
+export type HookEvent = {
+  name: string;
+  description: string;
+  products: Product[];
+};
+
+export type GetHookEventsResponse = APIResponse & {
+  events: HookEvent[];
+};
+
 export type GetReactionsAPIResponse = APIResponse & {
   reactions: ReactionResponse[];
 };

test/unit/client.test.js

@@ -1128,4 +1128,66 @@ describe('X-Stream-Client header', () => {
 
 		expect(userAgent).toMatchInlineSnapshot(`"deprecated"`);
 	});
+
+	describe('getHookEvents', () => {
+		let clientGetSpy;
+
+		beforeEach(() => {
+			clientGetSpy = vi.spyOn(client, 'get').mockResolvedValue({});
+		});
+
+		it('should call get with correct URL and no params when no products specified', async () => {
+			await client.getHookEvents();
+
+			expect(clientGetSpy).toHaveBeenCalledTimes(1);
+			expect(clientGetSpy).toHaveBeenCalledWith(`${client.baseURL}/hook/events`, {});
+		});
+
+		it('should call get with correct URL and empty params when empty products array specified', async () => {
+			await client.getHookEvents([]);
+
+			expect(clientGetSpy).toHaveBeenCalledTimes(1);
+			expect(clientGetSpy).toHaveBeenCalledWith(`${client.baseURL}/hook/events`, {});
+		});
+
+		it('should call get with product params when products specified', async () => {
+			await client.getHookEvents(['chat', 'video']);
+
+			expect(clientGetSpy).toHaveBeenCalledTimes(1);
+			expect(clientGetSpy).toHaveBeenCalledWith(`${client.baseURL}/hook/events`, {
+				product: 'chat,video',
+			});
+		});
+
+		it('should call get with single product param', async () => {
+			await client.getHookEvents(['chat']);
+
+			expect(clientGetSpy).toHaveBeenCalledTimes(1);
+			expect(clientGetSpy).toHaveBeenCalledWith(`${client.baseURL}/hook/events`, {
+				product: 'chat',
+			});
+		});
+
+		it('should return the response from get', async () => {
+			const mockResponse = {
+				events: [
+					{
+						name: 'message.new',
+						description: 'When a new message is added',
+						products: ['chat'],
+					},
+					{
+						name: 'call.created',
+						description: 'The call was created',
+						products: ['video'],
+					},
+				],
+			};
+			clientGetSpy.mockResolvedValue(mockResponse);
+
+			const result = await client.getHookEvents(['chat', 'video']);
+
+			expect(result).toEqual(mockResponse);
+		});
+	});
 });