Billing
Billing events: 12 in all. See the shared envelope.
billing_run.executed
A billing run finished.
Resource: billing_run
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_hpDL3x7Rxpn8ZWSraVQK8c76DqS",
"type": "billing_run.executed",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "billing_run",
"resource_id": "brn_hpDL3x7RxpnFuqFkrVc7h4j7aay",
"resource": {
"type": "billing_run",
"id": "brn_hpDL3x7RxpnFuqFkrVc7h4j7aay",
"sequence": 1
}
}
}billing_schedule.created
A billing schedule was created.
Resource: billing_schedule
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_hpDL3x7RmtWvFESrq9CN5ThL2PT",
"type": "billing_schedule.created",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "billing_schedule",
"resource_id": "bsc_hpDL3x7RmtWvFESrX2ZhHoxhpc5",
"resource": {
"type": "billing_schedule",
"id": "bsc_hpDL3x7RmtWvFESrX2ZhHoxhpc5",
"sequence": 1
}
}
}billing_schedule.updated
A billing schedule changed.
Resource: billing_schedule
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_hpDL3x7RmtWvFESrqDUXCasrWE6",
"type": "billing_schedule.updated",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "billing_schedule",
"resource_id": "bsc_hpDL3x7RmtWvFESrX2ZhHoxhpc5",
"resource": {
"type": "billing_schedule",
"id": "bsc_hpDL3x7RmtWvFESrX2ZhHoxhpc5",
"sequence": 1
}
}
}invoice.adjusted
A credit or debit note changed an invoice.
Resource: invoice
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_fHugZN3NkFtbtRCYwAevcUkVpVF",
"type": "invoice.adjusted",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQztt9Z7PCX7RG",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQztt9Z7PCX7RG",
"sequence": 1
}
}
}invoice.issued
An invoice was issued, by hand or by a billing run.
Resource: invoice
Trigger via CLI: gotactl events trigger invoice.issued
{
"id": "wev_fHugZN3NJqbpAXWTkrw2CHiWT3A",
"type": "invoice.issued",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQYYcigzJZK54b",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQYYcigzJZK54b",
"sequence": 1
}
}
}invoice.paid
An invoice reached a zero balance and is paid.
Resource: invoice
Trigger via CLI: gotactl events trigger invoice.paid
{
"id": "wev_fHugZN3NejcvvpJfmmimho23KWi",
"type": "invoice.paid",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQ7w4rmjzaM8jJ",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQ7w4rmjzaM8jJ",
"sequence": 1
}
}
}invoice.reconciled
An estimated invoice was reconciled with a reading.
Resource: invoice
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_fHugZN3NGxYdGwd2FPeV2a4e92W",
"type": "invoice.reconciled",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQiqd7bPihudgZ",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQiqd7bPihudgZ",
"sequence": 1
}
}
}invoice.status_changed
An invoice changed status.
Resource: invoice
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_fHugZN3NTTpwMbXSzZQApZb38gc",
"type": "invoice.status_changed",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQXBGBdM5adFYR",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQXBGBdM5adFYR",
"sequence": 1
}
}
}invoice.voided
An invoice was voided.
Resource: invoice
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_fHugZN3N3MRs9QY2d8d3aUaftYH",
"type": "invoice.voided",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQwT2BEBhEK2NS",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQwT2BEBhEK2NS",
"sequence": 1
}
}
}invoice.written_off
An unpaid balance was written off as bad debt.
Resource: invoice
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_fHugZN3NEJiAYVcsyDMWai2GGLW",
"type": "invoice.written_off",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "invoice",
"resource_id": "inv_fHugZN3VrLNRGcQkFUdjpnFKAwA",
"resource": {
"type": "invoice",
"id": "inv_fHugZN3VrLNRGcQkFUdjpnFKAwA",
"sequence": 1
}
}
}tariff.activated
A tariff version was activated.
Resource: tariff
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_daLjYyHHhpDXyo4aY7K36Vnhaer",
"type": "tariff.activated",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "tariff",
"resource": {
"type": "tariff",
"sequence": 1
}
}
}tariff.created
A tariff version was created.
Resource: tariff
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_daLjYyHtjHRDVCvUbnqptWda6No",
"type": "tariff.created",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "tariff",
"resource": {
"type": "tariff",
"sequence": 1
}
}
}Receiving these events
Your webhook endpoint receives each of these events as a POST with the shared envelope described in the table below. Check the signature before acting on it, answer quickly with a 2xx code and do the work afterwards: a slow or failed answer is sent again. The same event can arrive more than once, so use its id to ignore repeats.
| Field | Type | Meaning |
|---|---|---|
id | string | The event identifier; the same on every delivery attempt. |
type | string | The event name, for example invoice.issued. |
api_version | string | The API version the body is written in. |
tenant_id | string | The utility (workspace) where the event happened. |
created_at | string (RFC 3339) | When the event was recorded. |
request_id | string | The API request that caused the change, when there was one; links to the request log. |
data.resource_type | string | The type of the resource that changed. |
data.resource_id | string | That resource's identifier, to read it from the API. |
data.attributes | object | Fields specific to each event; may be absent. Read the resource from the API for its full state. |
data.resource.sequence | integer | Counts the events about the same resource; ignore an event that is not newer than the last one you applied. |
Other event categories
- Automationautomation.created, automation.deleted, automation.disabled, automation.enabled, automation.updated
- Collectionscollection.case_settled, collection.cutoff_order_generated, collection.payment_plan_created, collection_case.status_changed, collection_case_dunning.status_changed
- Connectionsconnection.application_created, connection.application_reviewed, connection.application_submitted, connection.installation_scheduled, connection.installed, connection.reconnected, connection.retired, connection.status_changed, connection.suspended, connection.updated
- Customersaccount.created, account.link_rejected, account.linked, account.membership_revoked, customer.created, property.created, property.transferred
- Developerwebhook.test
- Metadatametadata.updated
- Metersmeter.created, meter.exchanged, meter.installed, meter.reset, meter.status_changed, meter_device.status_changed, reading.accepted, reading.corrected, reading.flagged, reading.rejected
- Notificationsnotification_preference.updated
- Onboardingonboarding.approved, onboarding.information_requested, onboarding.rejected, onboarding.submitted
- Operationscrew.created, incident.reported, incident.resolved, interruption.completed, interruption.created, work_order.assigned, work_order.completed, work_order.created, work_order.dispatched, work_order.executed, work_order.status_changed
- Paymentsbank_statement.imported, cashier.shift_closed, cashier.shift_opened, payment.allocated, payment.received, payment.reversed, payment.status_changed
- Readingsreading.status_changed
- Subscriptionplatform_invoice.issued, platform_invoice.paid, subscription.plan_changed
- Supportticket.assigned, ticket.closed, ticket.commented, ticket.created, ticket.resolved