Payments
Payments events: 7 in all. See the shared envelope.
bank_statement.imported
A bank statement was imported and matched against payments.
Resource: bank_statement
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_hHiNHKZbfA7CmSY4hUKtuitWwYK",
"type": "bank_statement.imported",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "bank_statement",
"resource": {
"type": "bank_statement",
"sequence": 1
}
}
}cashier.shift_closed
A cashier shift was closed and counted.
Resource: cashier
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_Wgonx2PfPTp2Qq8gNrSQXMprQGx",
"type": "cashier.shift_closed",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "cashier",
"resource": {
"type": "cashier",
"sequence": 1
}
}
}cashier.shift_opened
A cashier shift was opened.
Resource: cashier
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_Wgonx2PfPTp2QqoAhBhc4g9oLEp",
"type": "cashier.shift_opened",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "cashier",
"resource": {
"type": "cashier",
"sequence": 1
}
}
}payment.allocated
A payment was allocated to invoices.
Resource: payment
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_QfhRhS7F6PdiLRRUTDpuxnJ2hHU",
"type": "payment.allocated",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "payment",
"resource_id": "pay_QfhRhS7jyh3N7wnBQwVRzv8WmoQ",
"resource": {
"type": "payment",
"id": "pay_QfhRhS7jyh3N7wnBQwVRzv8WmoQ",
"sequence": 1
}
}
}payment.received
A payment was posted.
Resource: payment
Trigger via CLI: gotactl events trigger payment.received
{
"id": "wev_QfhRhS7FkgowVaXpkxA27stNKYk",
"type": "payment.received",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "payment",
"resource_id": "pay_QfhRhS7jyh3N7wnfEocoCrbPfrh",
"resource": {
"type": "payment",
"id": "pay_QfhRhS7jyh3N7wnfEocoCrbPfrh",
"sequence": 1
}
}
}payment.reversed
A payment was reversed and its allocations undone.
Resource: payment
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_QfhRhS7Fkg9w7amSDDrthC9iYXX",
"type": "payment.reversed",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "payment",
"resource_id": "pay_QfhRhS7jyh3N7wnfE99NbmALiHT",
"resource": {
"type": "payment",
"id": "pay_QfhRhS7jyh3N7wnfE99NbmALiHT",
"sequence": 1
}
}
}payment.status_changed
A payment changed status (posted, reconciled, reversed).
Resource: payment
Not supported by `events trigger` (use the normal API flow).
{
"id": "wev_QfhRhS7FZjMQ4bDwzcqiusvnvXd",
"type": "payment.status_changed",
"api_version": "v1",
"tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
"created_at": "2026-11-19T09:30:00Z",
"data": {
"resource_type": "payment",
"resource_id": "pay_QfhRhS7jyh3N7wnU2qHYEmGcget",
"resource": {
"type": "payment",
"id": "pay_QfhRhS7jyh3N7wnU2qHYEmGcget",
"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
- Billingbilling_run.executed, billing_schedule.created, billing_schedule.updated, invoice.adjusted, invoice.issued, invoice.paid, invoice.reconciled, invoice.status_changed, invoice.voided, invoice.written_off, tariff.activated, tariff.created
- 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
- Readingsreading.status_changed
- Subscriptionplatform_invoice.issued, platform_invoice.paid, subscription.plan_changed
- Supportticket.assigned, ticket.closed, ticket.commented, ticket.created, ticket.resolved