Tapahtumat · Laskutus
invoice.paid
Lasku maksettu
Lasku maksettiin.
- Objektin tyyppi
- invoice
- Vastaanottavat webhookit
- Webhookit, joilla on admin-rooli
Hyötykuorma
idstringpakollinenTapahtuman tunnus (
evt_…), joka lähetetään myöswebhook-id-otsakkeena. Käytä sitä kaksoistoimitusten pudottamiseen.typestringpakollinenSallitut arvot:
invoice.paidcreated_atstring (date-time)pakollinenMilloin muutos tapahtui (UTC).
org_idintegerpakollinenapi_versionstringpakollinendata-skeeman sopimusversio.sequenceintegerToimituksen järjestysnumero webhookin sisällä (puuttuu testitapahtumalta).
payloadstringpakollinenthintarkoittaa, etteidata-kenttää ole: lue objekti API:n kautta.Sallitut arvot:
fullthindataobjectKentät
actor_idinteger | nullpakollinenKäyttäjä, joka teki toiminnon;
null, kun kyseessä on organisaation API-avain tai itse alusta.
testbooleanpakollinenPOST /v1/webhooks/{webhook_id}/test-toiminnon lähettämä testitapahtuma.
Esimerkkitoimitus
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "invoice.paid",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "invoice",
"id": "301"
},
"payload": "full",
"data": {
"invoice": {
"id": 301,
"number": "INV-2026-000301",
"amount": 1250,
"currency": "EUR",
"status": "paid",
"period_start": "2026-10-01T00:00:00Z",
"period_end": "2026-11-01T00:00:00Z",
"issued_at": "2026-10-24T10:00:00Z",
"due_at": "2026-11-07T10:00:00Z",
"paid_at": "2026-10-25T09:00:00Z"
},
"actor_id": null
},
"test": false
}Tapahtumien vastaanottaminen
Jokainen toimitus on POST-pyyntö webhookisi URL-osoitteeseen, ja sen runkona on tämä JSON. Tarkista webhook-signature-otsake (Standard Webhooks) ennen kuin luotat runkoon, vastaa 2xx-tilalla muutaman sekunnin kuluessa ja tee varsinainen työ vasta sen jälkeen. Saman webhookin toimitukset säilyttävät tapahtumien järjestyksen; epäonnistunutta toimitusta yritetään uudelleen yhä pidemmin tauoin.
Uusia tapahtumatyyppejä ja uusia kenttiä voi ilmestyä milloin tahansa: ohita tyypit ja kentät, joita et tunne.