client.webhooksOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/webhookswebhooks.list
Use this operation to list webhooks. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.webhooks.list(options: WebhookListOptions = {})- Return form
Promise- Operation ID
listWebhooks- Required scopes
webhooks:read- SDK parameters
options: WebhookListOptions- Query request fields
cursor?: stringlimit?: integer- Success
200 Array<Webhook> envelope
/webhookswebhooks.create
Use this operation to create a webhook. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.webhooks.create(data: WebhookCreate, options?: MutationOptions)- Return form
Promise- Operation ID
createWebhook- Required scopes
webhooks:write- SDK parameters
data: WebhookCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
WebhookCreateapplication/json- Success
200 Webhook envelope201 Webhook envelope
/webhooks/{id}webhooks.get
Use this operation to get a webhook. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.webhooks.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getWebhook- Required scopes
webhooks:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 Webhook envelope
/webhooks/{id}webhooks.update
Updates the destination, subscribed events, or enabled state of a credential-owned webhook using its latest strong revision. Setting disabled to false clears automatic delivery-failure suspension.
client.webhooks.update(id: string, data: WebhookUpdate, options: WebhookUpdateOptions)- Return form
Promise- Operation ID
updateWebhook- Required scopes
webhooks:write- SDK parameters
id: stringdata: WebhookUpdateoptions: WebhookUpdateOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
WebhookUpdateapplication/json- Success
200 Webhook envelope
/webhooks/{id}/secret-rotationwebhooks.rotateSecret
Rotates the signing-secret generation for a credential-owned v2 webhook. The secret is derived only for this no-store response, remains absent from URLs and persistent records, and is reproduced only for an exact idempotent replay.
client.webhooks.rotateSecret(id: string, options: WebhookSecretRotationOptions)- Return form
Promise- Operation ID
rotateWebhookSecret- Required scopes
webhooks:write- SDK parameters
id: stringoptions: WebhookSecretRotationOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Success
200 WebhookSecretRotation envelope201 WebhookSecretRotation envelope
/webhooks/{id}/test-deliverywebhooks.testDelivery
Queues a synthetic webhook.test event through the same cell-local worker, HTTPS, signing, retry, and delivery-history pipeline as a real event. The App re-authenticates the exact credential and verifies current workspace, principal, and credential ownership before the worker sends. Test outcomes never change webhook failCount, lastStatus, or disabled state.
client.webhooks.testDelivery(id: string, options: MutationOptions = {})- Return form
Promise- Operation ID
testWebhookDelivery- Required scopes
webhooks:write- SDK parameters
id: stringoptions: MutationOptions- Path request fields
id: string- Header request fields
Idempotency-Key: string- Success
200 WebhookTestDelivery envelope201 WebhookTestDelivery envelope
/webhooks/{id}webhooks.remove
Use this operation to remove a webhook. The operation preserves TeamGrid lifecycle and permission rules instead of bypassing them with a direct data deletion. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.webhooks.remove(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
removeWebhook- Required scopes
webhooks:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
204
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
webhooks.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.webhooks.pages(options?: WebhookListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.