WebhookGroups
Defined in: src/webhooks/client.gen.ts:8
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebhookGroups(
_core):WebhookGroups
Defined in: src/webhooks/client.gen.ts:9
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebhookGroups
Methods
Section titled “Methods”addMembers()
Section titled “addMembers()”addMembers(
id,body,options?):Promise<void>
Defined in: src/webhooks/client.gen.ts:18
Add Webhook Group Members
Adds members to webhook groups.
POST /v1/webhooks/groups/{id}/add_members
Parameters
Section titled “Parameters”string
members
Section titled “members”object[]
Description
The list of webhook group members to add to the group.
options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
create()
Section titled “create()”create(
body,options?):Promise<{id:string;name:string; }>
Defined in: src/webhooks/client.gen.ts:40
Create Webhook Group
Creates a webhook group.
POST /v1/webhooks/groups
Sends an Idempotency-Key header: options.idempotencyKey, or an auto-generated UUID.
Parameters
Section titled “Parameters”string
Description
The name for the webhook group.
Example
Some Webhook Groupoptions?
Section titled “options?”Returns
Section titled “Returns”Promise<{ id: string; name: string; }>
delete()
Section titled “delete()”delete(
id,options?):Promise<void>
Defined in: src/webhooks/client.gen.ts:60
Delete Webhook Group
Deletes a webhook group and all its members.
DELETE /v1/webhooks/groups/{id}
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
get(
id,options?):Promise<{id:string;name:string; }>
Defined in: src/webhooks/client.gen.ts:76
Get Webhook Group
Gets a webhook group.
GET /v1/webhooks/groups/{id}
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ id: string; name: string; }>
list()
Section titled “list()”list(
query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/webhooks/client.gen.ts:95
List Webhook Groups
Lists webhook groups.
GET /v1/webhooks/groups
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
Description
Cursor for pagination.
limit?
Section titled “limit?”number
Description
Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>
listMembers()
Section titled “listMembers()”listMembers(
id,query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/webhooks/client.gen.ts:114
List Webhook Group Members
Lists the members currently in the specified webhook group.
GET /v1/webhooks/groups/{id}/members
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”string
query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
Description
Cursor for pagination.
limit?
Section titled “limit?”number
Description
Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>
removeMembers()
Section titled “removeMembers()”removeMembers(
id,body,options?):Promise<void>
Defined in: src/webhooks/client.gen.ts:133
Remove Webhook Group Members
Removes members from webhook groups.
POST /v1/webhooks/groups/{id}/remove_members
Parameters
Section titled “Parameters”string
members
Section titled “members”object[]
Description
The list of webhook group members to remove from the group.
options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>