webhooks.test

Queue a synthetic delivery to confirm your endpoint receives and verifies deliveries: one signed attempt with Curviate-Test: true, never changing the webhook's health.

Prerequisites

A Curviate API key, passed as apiKey when you construct the client. Quickstart shows how to create one.

Signature

test(id: string, body?: WebhookTestBody): Promise<WebhookTestResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const { delivery_id } = await curviate.webhooks.test("wh_123", { event: "enrollment.finished" });

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Webhook id (wh_-prefixed ULID).
`event`	`string`	No	One of this webhook's subscribed event types; omitted: its first.

Returns

Resolves to WebhookTestResult. Top-level fields: object, webhook_id, test_id, event, test_event, delivery_id, queued_at.

Error codes

Code	What it means, and what to do
`UNAUTHORIZED`	The API key is missing, malformed, or revoked. Check the key you passed to the client.
`INVALID_REQUEST`	A parameter failed validation. The message names the offending field; fix the request rather than retrying it.
`RATE_LIMIT_ACCOUNT`	This account's own quota is exhausted. Wait for the window in the `Retry-After` header, then retry.
`RATE_LIMIT_TENANT`	The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
`PLATFORM_RATE_LIMIT`	LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
`PLATFORM_ERROR`	An upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries `retry_likely_to_succeed: false` and `retry_hint: {kind: "never"}`, retrying cannot help and backing off only delays the real answer.
`PAYLOAD_TOO_LARGE`	Three limits can trigger this. The platform's own ceiling on total request size is the lowest and the one you are most likely to hit: it starts rejecting at roughly 1 MB, so a handful of photo-sized images is refused even though it clears everything below. Above that, this API caps one attachment at 5 MiB of file content and the whole request body at 9 MiB. Attachments travel base64-encoded, which inflates them by about a third, so a 5 MiB file costs roughly 6.7 MiB of the body budget. Send fewer or smaller attachments; retrying unchanged will not help.
`RESOURCE_NOT_FOUND`	The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it.
`TEAM_REQUIRED`	See the error codes reference.

Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.

Next steps

webhooks.list: List the tenant's registered webhooks, cursor-paginated.
webhooks.listEvents: Return the complete canonical webhook event catalogue, grouped by source.
webhooks.get: Return a single webhook owned by the calling tenant.
SDK Quick Start: installation, the client, account scoping, and pagination.