misc(webhooks): Add header definitions (#326)

src/parameters/_index.yaml

@@ -1,12 +1,18 @@
 external_customer_id:
-  $ref: './external_customer_id.yaml'
+  $ref: "./external_customer_id.yaml"
 external_subscription_id:
-  $ref: './external_subscription_id.yaml'
+  $ref: "./external_subscription_id.yaml"
 lago_invoice_id:
-  $ref: './lago_invoice_id.yaml'
+  $ref: "./lago_invoice_id.yaml"
 months:
-  $ref: './months.yaml'
+  $ref: "./months.yaml"
 page:
-  $ref: './page.yaml'
+  $ref: "./page.yaml"
 per_page:
-  $ref: './per_page.yaml'
+  $ref: "./per_page.yaml"
+webhook_signature:
+  $ref: "./webhook_signature.yaml"
+webhook_signature_algorithm:
+  $ref: "./webhook_signature_algorithm.yaml"
+webhook_unique_key:
+  $ref: "./webhook_unique_key.yaml"

src/parameters/webhook_signature.yaml

@@ -0,0 +1,7 @@
+name: "X-Lago-Signature"
+in: header
+description: Signature of the webhook payload
+required: true
+schema:
+  type: string
+  example: "Ap\xB65\xC9\xBF\x9D\x9F\xCE\xA36\xD0fV\xA3\xC4\x15\x15\xBA\xF5\xD4\xF5\xD4[D\x8B\xE6A\xE2\xFF\xFC\xDA"

src/parameters/webhook_signature_algorithm.yaml

@@ -0,0 +1,10 @@
+name: "X-Lago-Signature-Algorithm"
+in: header
+description: Algorithm used to generate the signature
+required: true
+schema:
+  type: string
+  enum:
+    - jwt
+    - hmac
+  example: hmac

src/parameters/webhook_unique_key.yaml

@@ -0,0 +1,8 @@
+name: "X-Lago-Unique-Key"
+in: header
+description: Unique id of the webhook. It can be used for idempotency
+required: true
+schema:
+  type: string
+  format: uuid
+  example: "1a901a90-1a90-1a90-1a90-1a901a901a90"

src/webhooks/credit_note_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: creditNoteCreated
   description: A new credit note has been created
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new credit note
     content:

src/webhooks/credit_note_generated.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: creditNoteGenerated
   description: A new credit note PDF has been generated
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the credit note
     content:

src/webhooks/credit_note_provider_refund_failure.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: creditNoteProviderRefundFailure
   description: The refund of a credit note has failed on a payment provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the credit note and of the provider error
     content:

src/webhooks/customer_accounting_provider_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerAccountingProviderCreated
   description: A customer was created on an accouting integration
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer
     content:

src/webhooks/customer_accounting_provider_error.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerAccountingProviderError
   description: An error was encountered while syncing a customer to an accounting provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer and of the provider error
     content:

src/webhooks/customer_checkout_url_generated.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerCheckoutUrlGenerated
   description: A checkout URL was generated for a customer
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer with the generated checkout URL
     content:

src/webhooks/customer_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerCreated
   description: A new customer has been created
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new customer
     content:

src/webhooks/customer_crm_provider_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerCrmProviderCreated
   description: A customer has been created in the CRM provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer
     content:

src/webhooks/customer_crm_provider_error.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerCrmProviderError
   description: An error was encountered while syncing a customer to a CRM provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer and of the CRM provider error
     content:

src/webhooks/customer_payment_provider_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerPaymentProviderCreated
   description: A customer has been created on a payment provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer
     content:

src/webhooks/customer_payment_provider_error.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerPaymentProviderError
   description: An error was encountered while syncing a customer to a payment provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer and of the payment provider error
     content:

src/webhooks/customer_tax_provider_error.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerTaxProviderError
   description: An error was encountered while fetching taxes for a customer on a tax provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer and of the tax provider error
     content:

src/webhooks/customer_updated.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerUpdated
   description: A customer has been updated
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer
     content:

src/webhooks/customer_vies_check.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: customerViesCheck
   description: VIES VAT number has been checked for a customer
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the customer with the VIES VAT check status
     content:

src/webhooks/event_error.yaml

@@ -2,6 +2,10 @@ post:
   deprecated: true
   operationId: eventError
   description: An error has been detected on an event
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the event and of the error
     content:

src/webhooks/events_errors.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: eventsErrors
   description: Errors were encountered while post-processing some events
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the events errors
     content:

src/webhooks/fee_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: feeCreated
   description: A pay in advance fee has been created
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new fee
     content:

src/webhooks/fee_tax_provider_error.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: feeTaxProviderError
   description: An error was encountered while fetching taxes for a fee on a tax provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the fee and of the tax provider error
     content:

src/webhooks/integration_provider_error.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: integrationProviderError
   description: An error was encountered while processing data on an integration
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the integration and of the integration error
     content:

src/webhooks/invoice_add_on_added.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceAddOnAdded
   description: A new add on invoice has been emitted
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new invoice
     content:

src/webhooks/invoice_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceCreated
   description: A new invoice has been emitted
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new invoice
     content:

src/webhooks/invoice_drafted.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceDrafted
   description: A new draft invoice has been emitted
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new invoice
     content:

src/webhooks/invoice_generated.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceGenerated
   description: A new invoice PDF has been generated
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice
     content:

src/webhooks/invoice_one_off_created.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceOneOffCreated
   description: A new one off invoice has been emitted
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new invoice
     content:

src/webhooks/invoice_paid_credit_added.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoicePaidCreditAdded
   description: A new prepaid credit invoice has been emitted
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the new invoice
     content:

src/webhooks/invoice_payment_dispute_lost.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoicePaymentDisputeLost
   description: A payment dispute has been lost for an invoice payment
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice and of the payment dispute
     content:

src/webhooks/invoice_payment_failure.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoicePaymentFailure
   description: A payment attempt for an invoice has failed on a payment provider
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice and of the payment provider error
     content:

src/webhooks/invoice_payment_overdue.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoicePaymentOverdue
   description: An invoice payment is overdue
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice
     content:

src/webhooks/invoice_payment_status_updated.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoicePaymentStatusUpdated
   description: The payment status of an invoice has been updated
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice
     content:

src/webhooks/invoice_resynced.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceResynced
   description: An invoice has been resynced with salesforce
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice
     content:

src/webhooks/invoice_voided.yaml

@@ -1,6 +1,10 @@
 post:
   operationId: invoiceVoided
   description: An invoice has been voided
+  parameters:
+    - $ref: "../parameters/webhook_signature.yaml"
+    - $ref: "../parameters/webhook_signature_algorithm.yaml"
+    - $ref: "../parameters/webhook_unique_key.yaml"
   requestBody:
     description: Details of the invoice
     content: