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

Service connected

Delivered when a connection of a company is created. Only to the endpoints of the account that owns the company, never to an account that manages it.

Recommended actions:

  • Mark the service as connected for that company.

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"connection.connected"
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 connection.* events: the connection as it is after the change. The environment is the livemode of the event. Credentials are never part of it.

Response Body

NIF created

Delivered when an account holder you provisioned registers their first (or an additional) NIF (company) during onboarding. **Always verify `BeeL-Signature` before processing.**

Service disconnected

Delivered once when a connection becomes `DISCONNECTED`. Only to the endpoints of the account that owns the company. **Recommended actions:** - Mark the service as disconnected for that company. **Always verify `BeeL-Signature` before processing.**