Send a test event

Trigger a test delivery of a real catalog event type to this endpoint, marked test: true in the delivered envelope.

Unlike ping (a synthetic webhook.ping), this records a real Event (visible in GET /events) and queues a signed, retried WebhookDelivery.
Optionally pass type to choose which subscribed event to simulate.
The delivery reaches only this endpoint.

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 409 idempotency_key_reused. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Length1 <= length <= 255

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type?|

Value in

"invoice.created" | "invoice.auto_created" | "invoice.corrective_auto_created" | "invoice.subscription_auto_created" | "invoice.updated" | "invoice.sent" | "invoice.paid" | "invoice.cancelled" | "invoice.annulled" | "invoice.overdue" | "invoice.deleted" | "invoice.number_assigned" | "invoice.rectified" | "invoice.email_sent" | "invoice.email_failed" | "invoice.payment_reminder_sent" | "invoice.simplified_created" | "invoice.simplified_substituted" | "invoice.substituted_by_complete" | "invoice.verifactu_submitted" | "invoice.verifactu_failed" | "invoice.metadata_changed" | "quote.created" | "quote.updated" | "quote.deleted" | "quote.approved" | "quote.rejected" | "quote.converted" | "quote.expired" | "quote.marked_as_pending" | "quote.cancelled" | "quote.number_assigned" | "quote.metadata_changed" | "quote.email_sent" | "quote.email_failed" | "proforma.created" | "proforma.updated" | "proforma.deleted" | "proforma.accepted" | "proforma.rejected" | "proforma.cancelled" | "proforma.expired" | "proforma.converted_to_invoice" | "proforma.number_assigned" | "proforma.metadata_changed" | "proforma.email_sent" | "proforma.email_failed" | "delivery_note.created" | "delivery_note.updated" | "delivery_note.status_changed" | "delivery_note.signed" | "delivery_note.converted" | "delivery_note.email_sent" | "delivery_note.email_failed" | "purchase_invoice.created" | "purchase_invoice.updated" | "purchase_invoice.paid" | "purchase_invoice.cancelled" | "purchase_invoice.metadata_changed" | "purchase_invoice.payment_registered" | "recurring_invoice.created" | "recurring_invoice.activated" | "recurring_invoice.paused" | "recurring_invoice.updated" | "recurring_invoice.deleted" | "recurring_invoice.completed" | "recurring_invoice.executed" | "recurring_invoice.failed" | "recurring_invoice.metadata_changed" | "recurring_invoice.cancelled" | "client.created" | "client.updated" | "client.deleted" | "client.metadata_changed" | "contact.created" | "contact.updated" | "contact.archived" | "contact.restored" | "contact.deleted" | "contact.role.assigned" | "contact.role.activated" | "contact.role.deactivated" | "contact.role.removed" | "contact.customer_profile.updated" | "contact.supplier_profile.updated" | "product.created" | "product.updated" | "payment.received" | "payment.reversed" | "tax.metadata_changed" | "tax.validity_changed" | "tax.external_reference_changed" | "series.created" | "series.updated" | "series.deleted" | "series.archived" | "series.unarchived" | "series.marked_as_default" | "series.demoted_from_default" | "series.year_reset" | "series.month_reset" | "series.number_consumed" | "facturae.face_submitted" | "facturae.face_status_changed" | "facturae.face_cancellation_requested" | "payout.reconciled" | "mandate.activated" | "mandate.cancelled" | "mandate.expired" | "employee.created" | "employee.updated" | "employee.deactivated" | "employee.invited" | "time_entry.recorded" | "time_entry.corrected" | "absence.requested" | "absence.approved" | "absence.rejected" | "monthly_register.closed" | "automation_rule.activated" | "automation_rule.paused" | "automation_rule.auto_paused" | "automation_run.started" | "automation_run.completed" | "automation_run.failed" | "automation_run.step_dead_lettered" | "order.invoiced" | "order.refunded" | null

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/webhook_endpoints/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/test_event", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-webhook_endpoints-test_event"} },  body: JSON.stringify({}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "object": "webhook_test_event",
    "test": false,
    "type": null
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_d170078272e7927ed1f1ef4470"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'webhooks:write'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_119e9410567a61524e563e2de1"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "webhook_endpoint_not_found",
    "message": "Endpoint webhook no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#webhook_endpoint_not_found",
    "request_id": "req_74cedcc5b9d8cfdcc609799d5e"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_28536fb414cd83d0723d33fef6"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_637b1fd3d5e0af4e6ad06a26bd"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_613a253b9f830cd2973c8ba882"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_8f12d22a82576915343b489a39"
  }
}

Send a test event

Authorization

Path Parameters

Headers

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Send a test event

Authorization

Path Parameters

Headers

Request Body

Response Body

202application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`