Skip to navigation
API ReferenceWebhooks

Send a test event

View as Markdown

Sends one signed delivery to the endpoint immediately and returns the result of that attempt. Without a body (or with {}), it sends webhook.test, whose data is { "message": "Este es un evento de prueba de Jelliu.", "webhook_id": "<this endpoint>" }. With { "type": "<event type>" }, it sends that type with the catalog’s example data, to exercise the handler for a specific event. The request is signed and structured exactly like a real delivery (same headers, same envelope, a new evt_ id).

The test also works on a disabled endpoint, so the endpoint can be verified before it is re-enabled. It is a single attempt (a failure is not retried), appears in the delivery log with manual: true, and does not affect endpoint health. Test events are never re-sent by POST /api/webhooks/{webhookId}/replay.

The response is 200 regardless of the endpoint’s response; check success, status_code and error.

Side effects. One HTTP request to the endpoint (10-second timeout) and one delivery record in its log.

Idempotency. Not idempotent: every call sends a new test event with a new id.

Access

  • Required scope: full. Human users need the owner or admin role.
  • Rate limit: General API (120–600 requests/min per workspace, by plan) plus the configuration-mutations limit — 10 requests/min per workspace, shared with other configuration changes. See Rate limits.
  • Plan: Requires an active subscription (active, trialing or past_due); without one the request is refused with 403 BILLING_ERROR (metadata.kind: subscription_required). See Billing and usage.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Path parameters

webhookIdstringRequiredformat: "uuid"

UUID of the outbound webhook endpoint, returned as id by GET /api/webhooks. It must belong to the authenticated workspace; an id from another workspace, an unknown id or a value that is not a UUID answers 404.

Request

This endpoint expects an object.
typestringOptional<=100 characters

Event type to send with its catalog example data. Defaults to webhook.test. Must be a type that is available now (see GET /api/webhooks/event-types).

Response

The attempt was made. success indicates whether the endpoint returned 2xx.

dataobject

Result of the single attempt made by POST /api/webhooks/{webhookId}/test.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error