Skip to content

Commit 86a22b4

Browse files
Merge pull request #175 from FacturAPI/chore/webhook_description
chore(webhook): add description for new webhook
2 parents 51525dc + 87bf9c4 commit 86a22b4

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed

website/openapi_v2.en.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6159,6 +6159,39 @@ x-webhooks:
61596159
- invoice
61606160
object:
61616161
$ref: "#/components/schemas/Invoice"
6162+
"Invoice created from dashboard":
6163+
post:
6164+
summary: Invoice created from dashboard
6165+
description: |
6166+
Notifies when an invoice was created from Facturapi Dashboard.
6167+
tags:
6168+
- events
6169+
requestBody:
6170+
required: true
6171+
content:
6172+
application/json:
6173+
schema:
6174+
allOf:
6175+
- $ref: "#/components/schemas/EventBase"
6176+
- type: object
6177+
properties:
6178+
type:
6179+
type: string
6180+
description: Type of event
6181+
exacmple: "invoice.created_from_dashboard"
6182+
enum:
6183+
- invoice.created_from_dashboard
6184+
data:
6185+
type: object
6186+
properties:
6187+
type:
6188+
type: string
6189+
description: Type of object associated with the event
6190+
enum:
6191+
- invoice
6192+
object:
6193+
$ref: "#/components/schemas/Invoice"
6194+
61626195
"Cancellation status updated":
61636196
post:
61646197
tags:

website/openapi_v2.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6107,6 +6107,38 @@ x-webhooks:
61076107
- invoice
61086108
object:
61096109
$ref: "#/components/schemas/Invoice"
6110+
"Creación de factura desde dashboard":
6111+
post:
6112+
summary: Creación de factura desde dashboard
6113+
description: |
6114+
Notifica cuandos se crea una factura desde dashboard de Facturapi.
6115+
tags:
6116+
- events
6117+
requestBody:
6118+
required: true
6119+
content:
6120+
application/json:
6121+
schema:
6122+
allOf:
6123+
- $ref: "#/components/schemas/EventBase"
6124+
- type: object
6125+
properties:
6126+
type:
6127+
type: string
6128+
description: Tipo de evento
6129+
example: "invoice.created_from_dashboard"
6130+
enum:
6131+
- invoice.created_from_dashboard
6132+
data:
6133+
type: object
6134+
properties:
6135+
type:
6136+
type: string
6137+
description: Tipo de objeto asociado al evento
6138+
enum:
6139+
- invoice
6140+
object:
6141+
$ref: "#/components/schemas/Invoice"
61106142
"Estatus de cancelación actualizado":
61116143
post:
61126144
tags:
@@ -7761,6 +7793,7 @@ components:
77617793
enum:
77627794
- "invoice.global_invoice_created"
77637795
- "invoice.status_updated"
7796+
- "invoice.created_from_dashboard"
77647797
- "invoice.cancellation_status_updated"
77657798
- "receipt.self_invoice_complete"
77667799
- "receipt.status_updated"

0 commit comments

Comments
 (0)