Skip to content

Commit fa38283

Browse files
chore(related_message): add new related message for invoice.status_updated (#281)
1 parent 8f45615 commit fa38283

2 files changed

Lines changed: 140 additions & 0 deletions

File tree

website/openapi_v2.en.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10842,6 +10842,44 @@ x-webhooks:
1084210842
- invoice
1084310843
object:
1084410844
$ref: "#/components/schemas/Invoice"
10845+
related_resource_messages:
10846+
type: array
10847+
description: Messages related to the resource associated with the event.
10848+
items:
10849+
$ref: "#/components/schemas/RelatedResourceMessage"
10850+
examples:
10851+
with_related_messages:
10852+
summary: With related messages
10853+
value:
10854+
id: evt_xxx
10855+
created_at: "2026-07-01T12:00:00.000Z"
10856+
livemode: true
10857+
organization: org_xxx
10858+
type: invoice.status_updated
10859+
data:
10860+
type: invoice
10861+
object:
10862+
id: invoice_xxx
10863+
related_resource_messages:
10864+
- resource_type: invoice
10865+
resource_id: invoice_xxx
10866+
source: stamping_async_task
10867+
severity: error
10868+
message: The receiver RFC is not valid
10869+
created_at: "2026-01-01T00:00:00.000Z"
10870+
without_related_messages:
10871+
summary: Without related messages
10872+
value:
10873+
id: evt_xxx
10874+
created_at: "2026-07-01T12:00:00.000Z"
10875+
livemode: true
10876+
organization: org_xxx
10877+
type: invoice.status_updated
10878+
data:
10879+
type: invoice
10880+
object:
10881+
id: invoice_xxx
10882+
related_resource_messages: []
1084510883
"Invoice created from dashboard":
1084610884
post:
1084710885
summary: Invoice created from dashboard
@@ -11257,6 +11295,38 @@ components:
1125711295
description: Number from 1 to 100 representing the maximum amount of results to return for pagination purposes.
1125811296

1125911297
schemas:
11298+
RelatedResourceMessage:
11299+
type: object
11300+
properties:
11301+
resource_type:
11302+
type: string
11303+
description: Type of related resource.
11304+
example: invoice
11305+
resource_id:
11306+
type: string
11307+
description: ID of the related resource.
11308+
example: invoice_xxx
11309+
source:
11310+
type: string
11311+
description: Source of the message.
11312+
example: stamping_async_task
11313+
severity:
11314+
type: string
11315+
description: Severity of the message.
11316+
enum:
11317+
- error
11318+
- warning
11319+
- info
11320+
example: error
11321+
message:
11322+
type: string
11323+
description: Message related to the resource.
11324+
example: The receiver RFC is not valid
11325+
created_at:
11326+
type: string
11327+
format: date-time
11328+
description: Creation date and time of the message.
11329+
example: "2026-01-01T00:00:00.000Z"
1126011330
EventBase:
1126111331
type: object
1126211332
properties:

website/openapi_v2.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11048,6 +11048,44 @@ x-webhooks:
1104811048
- invoice
1104911049
object:
1105011050
$ref: "#/components/schemas/Invoice"
11051+
related_resource_messages:
11052+
type: array
11053+
description: Mensajes relacionados con el recurso asociado al evento.
11054+
items:
11055+
$ref: "#/components/schemas/RelatedResourceMessage"
11056+
examples:
11057+
with_related_messages:
11058+
summary: Con mensajes relacionados
11059+
value:
11060+
id: evt_xxx
11061+
created_at: "2026-07-01T12:00:00.000Z"
11062+
livemode: true
11063+
organization: org_xxx
11064+
type: invoice.status_updated
11065+
data:
11066+
type: invoice
11067+
object:
11068+
id: invoice_xxx
11069+
related_resource_messages:
11070+
- resource_type: invoice
11071+
resource_id: invoice_xxx
11072+
source: stamping_async_task
11073+
severity: error
11074+
message: El RFC del receptor no es válido
11075+
created_at: "2026-01-01T00:00:00.000Z"
11076+
without_related_messages:
11077+
summary: Sin mensajes relacionados
11078+
value:
11079+
id: evt_xxx
11080+
created_at: "2026-07-01T12:00:00.000Z"
11081+
livemode: true
11082+
organization: org_xxx
11083+
type: invoice.status_updated
11084+
data:
11085+
type: invoice
11086+
object:
11087+
id: invoice_xxx
11088+
related_resource_messages: []
1105111089
"Creación de factura desde dashboard":
1105211090
post:
1105311091
summary: Creación de factura desde dashboard
@@ -11492,6 +11530,38 @@ components:
1149211530
message:
1149311531
type: string
1149411532
description: Descripción del error y posible sugerencia.
11533+
RelatedResourceMessage:
11534+
type: object
11535+
properties:
11536+
resource_type:
11537+
type: string
11538+
description: Tipo de recurso relacionado.
11539+
example: invoice
11540+
resource_id:
11541+
type: string
11542+
description: ID del recurso relacionado.
11543+
example: invoice_xxx
11544+
source:
11545+
type: string
11546+
description: Origen del mensaje.
11547+
example: stamping_async_task
11548+
severity:
11549+
type: string
11550+
description: Severidad del mensaje.
11551+
enum:
11552+
- error
11553+
- warning
11554+
- info
11555+
example: error
11556+
message:
11557+
type: string
11558+
description: Mensaje relacionado con el recurso.
11559+
example: El RFC del receptor no es válido
11560+
created_at:
11561+
type: string
11562+
format: date-time
11563+
description: Fecha y hora de creación del mensaje.
11564+
example: "2026-01-01T00:00:00.000Z"
1149511565
EventBase:
1149611566
type: object
1149711567
properties:

0 commit comments

Comments
 (0)