Webhooks
testWebhookEndpoint
Send a test event
Enqueues a test event delivery to the webhook endpoint.
Usage
const result = await api.webhooks.testWebhookEndpoint({
pathParams: { project_id: "prj_xxx", webhook_id: "whk_xxx" },
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| pathParams.webhook_id | string | Yes | Unique webhook endpoint identifier (prefixed, e.g. whk_xxx). |
Response
Promise<unknown> — the result.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.webhooks.testWebhookEndpoint({
pathParams: { project_id: "prj_xxx", webhook_id: "whk_xxx" },
});Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Operation not allowed by current plan limits. |
| 404 | Resource not found. |