TeamGriddeveloper
TeamGrid Developer

Process webhooks reliably

Verify, acknowledge and process TeamGrid webhook deliveries without losing events.

Verify the raw request

Validate the signature against the exact bytes received from TeamGrid before parsing JSON. Enforce a bounded body size and reject signatures outside the documented timestamp tolerance.

The TypeScript SDK exposes verifyTeamGridWebhook for this purpose. Keep the webhook secret in a secret manager and support overlapping secrets during a controlled rotation.

Acknowledge quickly

After verification, store the delivery ID and payload in a durable queue, then return a success response. Do not perform slow third-party calls while TeamGrid is waiting for acknowledgement.

Use the delivery ID as a deduplication key. Delivery is at least once, so a receiver must treat a repeat as normal.

Exercise the real delivery path safely

After configuring the receiver, queue a synthetic webhook.test through the same worker, signing, HTTPS, retry, and history path as production events:

const test = await client.webhooks.testDelivery('webhook-id', {
  idempotencyKey: 'receiver-smoke-2026-08-10',
})

console.log(test.data.id, test.data.attributes.replayed)

The test uses webhooks:write. Reusing the same idempotency key recovers the same logical request; choose a new key for another test. A failed test never increments the webhook failure counter, changes its last production status, or disables it automatically. Inspect the credential-owned delivery history for the test outcome.

Re-read important resources

A webhook tells you that something changed. When correctness matters, fetch the current resource through API v1 before applying a downstream update. This avoids building state from an event that was followed immediately by another change.

Operate the receiver

Monitor signature failures, queue age and repeated processing errors separately. Rotate the secret through POST /webhooks/{id}/secret-rotation, confirm the new receiver path, then retire the old secret.

See signed webhooks and the SDK verification guide for the exact contract.

Stable documentation · Security · Reviewed 2026-08-10Edit this page ↗
Documentation feedbackWas this page useful?
Esc

Search TeamGrid Developer

Find guides, concepts and every API operation.