NewConnections and customer replies to invoices
BeeL
Get startedMulti-NIFVeriFactuRulesStripeAPI referenceChangelog
Webhook Events

Invoice reply deleted

Delivered once when the company deletes a reply, usually to answer an erasure request. Only to the endpoints of the account that owns the company. It carries identifiers only.

Recommended actions:

  • Erase what you stored about the reply from earlier invoice.reply.* events.
  • Discard an invoice.reply.received with the same reply_id that arrives after it. BeeL. stops sending it once the reply is deleted, but a retry already scheduled can still arrive.

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" | "email_domain.verified" | "email_domain.failed" | "email_domain.removed" | "connection.connected" | "connection.disconnected" | "invoice.reply.received" | "invoice.reply.deleted" | "invoice.email.bounced"
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

Request Body

idstring

Unique identifier of this webhook event delivery.

Formatuuid
typestring
Value in"invoice.reply.deleted"
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

Payload for invoice.reply.deleted events. Identifiers only. An invoice.reply.received with the same reply_id that arrives after it is a late retry: discard it.

Response Body

Invoice reply received

Delivered when a reply of a customer about an invoice is stored, on any channel and also when you register it. Only to the endpoints of the account that owns the company, never to an account that manages it, which can still read the replies with `GET .../invoice-replies`. It carries a masked `excerpt`, `subject` and `sender.address`; read the reply for the full text. **Recommended actions:** - Show the reply next to its invoice, routing on `channel`. - Subscribe to `invoice.reply.deleted` if you keep a copy. **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`), and then the AEAT answers it (usually within seconds to minutes). Sent when the public status changes (`new_status` differs from `previous_status`) and, while the status stays `REJECTED`, when the reason for the rejection changes (a different `error_code` or public `error_message`). See the `previous_status` property for when it is absent. A temporary AEAT server error keeps the record `PENDING` while BeeL. retries it, and sends no webhook. A technical problem on BeeL.'s side while submitting it also keeps it `PENDING` until BeeL. submits it again: it is not an outcome, so there is nothing to do. **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 `ACCEPTED_WITH_ERRORS`:** - Store `invoice_hash` and `qr_url` for audit trail; the QR code (`qr_base64`) is valid too. - The record stands at the AEAT, but it also reported errors in it: review the data flagged in `error_code` and `error_message` and tell the user. **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.**