Send a test webhook | Saperly Docs

Sends a test webhook to the specified line’s webhook URL. Useful for verifying webhook endpoint connectivity and response handling. The outbound payload is a TestEvent and carries the standard webhook headers — the signature trio (x-saperly-timestamp, x-saperly-delivery-id, x-saperly-signature) plus the x-saperly-delivery-attempt header — and an event_id field in the signed body (the idempotency key). See the TestEvent and WebhookSignatureHeaders schemas for shape, and webhook mode — signature verification for the verification flow.

Sends a test webhook to the specified line's webhook URL. Useful for verifying webhook endpoint connectivity and response handling. The outbound payload is a `TestEvent` and carries the standard webhook headers — the signature trio (`x-saperly-timestamp`, `x-saperly-delivery-id`, `x-saperly-signature`) plus the `x-saperly-delivery-attempt` header — and an `event_id` field in the signed body (the idempotency key). See the `TestEvent` and `WebhookSignatureHeaders` schemas for shape, and [webhook mode — signature verification](https://saperly.com/docs/guides/webhook-mode#signature-verification) for the verification flow.

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Request

This endpoint expects an object.

line_idstringRequiredformat: "uuid"

ID of the line whose webhook URL to test

Response

Test result

deliveryobject

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	const url = 'https://saperly.com/api/v1/webhooks/test';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"line_id":"string"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"delivery": {
3	"id": "string",
4	"status": "success",
5	"http_status": 1,
6	"duration_ms": 1,
7	"response_body": "string"
8	}
9	}