NewProvince is only required for addresses in Spain
BeeL
Get startedMulti-NIFVeriFactuRulesStripeAPI referenceChangelog
Webhook Events

Fiscal representation signed

Delivered when an account holder you provisioned signs the VeriFactu fiscal representation for one of their NIFs, enabling production invoicing on their behalf for that NIF.

Always verify BeeL-Signature before processing.


Header Parameters

BeeL-Signaturestring

HMAC-SHA256 signature. Format: t=<unix_timestamp>,v1=<hex_signature>

Verify this before processing any event (see spec description for algorithm).

Match^t=\d+,v1=[0-9a-f]{64}$
BeeL-Eventstring

Canonical event type identifier (matches the type field of the payload).

Value in"verifactu.status.updated" | "invoice.issued" | "invoice.email.sent" | "invoice.pdf.generated" | "invoice.voided" | "recurring_invoice.paused" | "invoice.schedule_failed" | "account.claimed" | "company.created" | "representation.signed"
BeeL-Event-Idstring

UUID of the logical webhook event. Identical across all retry attempts. Matches the id field in the payload. Use this for idempotency deduplication.

Formatuuid
BeeL-Delivery-Idstring

UUID of this specific delivery attempt. Unique per HTTP call, even for retries of the same event. Use this to correlate with delivery logs in the BeeL. dashboard.

Formatuuid
Idempotency-Keystring

Same value as BeeL-Event-Id. Standard idempotency header for deduplication.

Formatuuid
idstring

Unique identifier of this webhook event delivery.

Formatuuid
typestring
Value in"representation.signed"
created_atstring

ISO-8601 timestamp when the event was created.

Formatdate-time
api_versionstring

BeeL. API version that generated this event.

livemodebooleanDeprecated

Deprecated in favour of the TEST/PROD environment vocabulary: livemode: true is equivalent to environment PROD.

test?boolean|null

true only for test deliveries triggered manually from the BeeL. dashboard.

company_id?string|null

Unique identifier (UUID) of the company the event is about, or null when not scoped to a specific company. A single endpoint receives events for every company it manages (multi-NIF / accounting firms); route on this field.

Formatuuid
nif?string|null

NIF of the company the event is about (human-readable identifier).

account_id?string|null

Account the event happened in. For your own events this is your account; for events of accounts you manage it identifies which one. Route on this field together with account_external_ref.

Formatuuid
account_external_ref?string|null

Your own identifier for that account, as supplied when you provisioned it (external_ref). Lets you map the event onto your internal record without an extra lookup. null for accounts you did not provision.

account_relationship?string|null

How account_id relates to you: own when the event happened in your own account, managed when it happened in an account you manage. Same field name and vocabulary as the account_relationship you set on POST /v1/webhooks to choose which of these you receive (own by default; all there means both).

Value in"own" | "managed" | null
data

Response Body

Recurring invoice paused

Delivered when a recurring invoice (schedule) stops generating **without anyone asking for it** — a plan downgrade or an unattended generation that failed with something waiting will not fix. A schedule paused by a person is not delivered: whoever paused it already knows. **Why this matters:** the invoice that schedule was going to issue this period will not arrive. If your billing depends on it, nothing else will tell you — the account holder may never open the dashboard. **Trigger:** the daily generation batch pauses the schedule. **Recommended actions:** - Stop expecting that invoice for the current period. - If `reason` is `GENERATION_FAILURE`, fix the `blocker` (it is the same vocabulary the emission API returns in a 422 `EMISSION_NOT_READY`) and resume the schedule. **Also delivered in Test.** Sandbox is a faithful rehearsal of the mechanism, so you can see this failure mode before it happens in Live. **Always verify `BeeL-Signature` before processing.**

VeriFactu registration status changed

Delivered whenever the VeriFactu registration status of an invoice changes, starting with `PENDING` when the record is submitted. **Trigger:** the record is submitted (`PENDING`, with no `previous_status`), and then the AEAT answers it (usually within seconds to minutes). Sent only when the public status changes (`new_status` differs from `previous_status`): a temporary AEAT server error keeps the record `PENDING` while BeeL. retries it, and sends no webhook. **Recommended actions on `ACCEPTED`:** - Store `invoice_hash` and `qr_url` for audit trail. - Embed the QR code (`qr_base64`) in the customer's PDF if needed. **Recommended actions on `REJECTED`:** - Alert the user — they need to correct and resubmit the invoice. - Log `error_code` and `error_message` for debugging. **Always verify `BeeL-Signature` before processing.**