diff --git a/openapi.yaml b/openapi.yaml index 70a9918..fc29470 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2984,6 +2984,10 @@ webhooks: customer_created: post: description: A new customer has been created + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new customer content: @@ -3011,6 +3015,10 @@ webhooks: customer_updated: post: description: A customer has been updated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer content: @@ -3038,6 +3046,10 @@ webhooks: customer_accounting_provider_created: post: description: A customer was created on an accouting integration + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer content: @@ -3065,6 +3077,10 @@ webhooks: customer_accounting_provider_error: post: description: An error was encountered while syncing a customer to an accounting provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer and of the provider error content: @@ -3092,6 +3108,10 @@ webhooks: customer_crm_provider_created: post: description: A customer has been created in the CRM provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer content: @@ -3119,6 +3139,10 @@ webhooks: customer_crm_provider_error: post: description: An error was encountered while syncing a customer to a CRM provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer and of the CRM provider error content: @@ -3146,6 +3170,10 @@ webhooks: customer_payment_provider_created: post: description: A customer has been created on a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer content: @@ -3173,6 +3201,10 @@ webhooks: customer_payment_provider_error: post: description: An error was encountered while syncing a customer to a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer and of the payment provider error content: @@ -3200,6 +3232,10 @@ webhooks: customer_checkout_url_generated: post: description: A checkout URL was generated for a customer + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer with the generated checkout URL content: @@ -3227,6 +3263,10 @@ webhooks: customer_tax_provider_error: post: description: An error was encountered while fetching taxes for a customer on a tax provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer and of the tax provider error content: @@ -3254,6 +3294,10 @@ webhooks: customer_vies_check: post: description: VIES VAT number has been checked for a customer + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the customer with the VIES VAT check status content: @@ -3281,6 +3325,10 @@ webhooks: credit_note_created: post: description: A new credit note has been created + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new credit note content: @@ -3308,6 +3356,10 @@ webhooks: credit_note_generated: post: description: A new credit note PDF has been generated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the credit note content: @@ -3335,6 +3387,10 @@ webhooks: credit_note_provider_refund_failure: post: description: The refund of a credit note has failed on a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the credit note and of the provider error content: @@ -3363,6 +3419,10 @@ webhooks: post: deprecated: true description: An error has been detected on an event + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the event and of the error content: @@ -3390,6 +3450,10 @@ webhooks: events_errors: post: description: Errors were encountered while post-processing some events + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the events errors content: @@ -3417,6 +3481,10 @@ webhooks: fee_created: post: description: A pay in advance fee has been created + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new fee content: @@ -3444,6 +3512,10 @@ webhooks: fee_tax_provider_error: post: description: An error was encountered while fetching taxes for a fee on a tax provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the fee and of the tax provider error content: @@ -3471,6 +3543,10 @@ webhooks: invoice_created: post: description: A new invoice has been emitted + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new invoice content: @@ -3498,6 +3574,10 @@ webhooks: invoice_one_off_created: post: description: A new one off invoice has been emitted + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new invoice content: @@ -3525,6 +3605,10 @@ webhooks: invoice_add_on_added: post: description: A new add on invoice has been emitted + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new invoice content: @@ -3552,6 +3636,10 @@ webhooks: invoice_paid_credit_added: post: description: A new prepaid credit invoice has been emitted + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new invoice content: @@ -3579,6 +3667,10 @@ webhooks: invoice_generated: post: description: A new invoice PDF has been generated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice content: @@ -3606,6 +3698,10 @@ webhooks: invoice_drafted: post: description: A new draft invoice has been emitted + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new invoice content: @@ -3633,6 +3729,10 @@ webhooks: invoice_voided: post: description: An invoice has been voided + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice content: @@ -3660,6 +3760,10 @@ webhooks: invoice_payment_dispute_lost: post: description: A payment dispute has been lost for an invoice payment + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice and of the payment dispute content: @@ -3687,6 +3791,10 @@ webhooks: invoice_payment_status_updated: post: description: The payment status of an invoice has been updated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice content: @@ -3714,6 +3822,10 @@ webhooks: invoice_payment_overdue: post: description: An invoice payment is overdue + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice content: @@ -3741,6 +3853,10 @@ webhooks: invoice_payment_failure: post: description: A payment attempt for an invoice has failed on a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice and of the payment provider error content: @@ -3768,6 +3884,10 @@ webhooks: invoice_resynced: post: description: An invoice has been resynced with salesforce + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the invoice content: @@ -3795,6 +3915,10 @@ webhooks: integration_provider_error: post: description: An error was encountered while processing data on an integration + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the integration and of the integration error content: @@ -3822,6 +3946,10 @@ webhooks: payment_requires_action: post: description: An action is required to process a payment + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the payment and of the required action content: @@ -3849,6 +3977,10 @@ webhooks: payment_provider_error: post: description: An error was raised by a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the payment provider and of the error content: @@ -3876,6 +4008,10 @@ webhooks: payment_request_created: post: description: An new payment request has been created + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the new payment request content: @@ -3903,6 +4039,10 @@ webhooks: payment_request_payment_failure: post: description: A payment attempt for a payment request has failed on a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the payment request and of the provider error content: @@ -3930,6 +4070,10 @@ webhooks: payment_request_payment_status_updated: post: description: The payment status of an invoice has been updated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the payment request content: @@ -3957,6 +4101,10 @@ webhooks: subscription_terminated: post: description: A subscription has been terminated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the subscription content: @@ -3984,6 +4132,10 @@ webhooks: subscription_started: post: description: An subscription has started + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the subscription content: @@ -4011,6 +4163,10 @@ webhooks: subscription_termination_alert: post: description: A subscription will be terminated in the future + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the subscription content: @@ -4038,6 +4194,10 @@ webhooks: subscription_trial_ended: post: description: A subscription trial period has ended + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the subscription content: @@ -4065,6 +4225,10 @@ webhooks: subscription_usage_threshold_reached: post: description: A usage threshold has been reached by a subscription + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the subscription and of the reached threshold content: @@ -4092,6 +4256,10 @@ webhooks: wallet_depleted_ongoing_balance: post: description: The balance of a wallet has been depleted + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the wallet content: @@ -4119,6 +4287,10 @@ webhooks: wallet_transaction_created: post: description: A new wallet transaction has been created + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the wallet transaction content: @@ -4146,6 +4318,10 @@ webhooks: wallet_transaction_updated: post: description: A wallet transaction has been updated + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the wallet transaction content: @@ -4173,6 +4349,10 @@ webhooks: wallet_transaction_payment_failure: post: description: A payment attempt for a wallet transaction has failed on a payment provider + parameters: + - $ref: '#/components/parameters/webhook_signature' + - $ref: '#/components/parameters/webhook_signature_algorithm' + - $ref: '#/components/parameters/webhook_unique_key' requestBody: description: Details of the wallet transaction and of the provider error content: @@ -4253,6 +4433,34 @@ components: schema: type: integer example: 20 + webhook_signature: + name: X-Lago-Signature + in: header + description: Signature of the webhook payload + required: true + schema: + type: string + example: "Ap¶5É¿\x9D\x9FΣ6ÐfV£Ä\x15\x15ºõÔõÔ[D\x8BæAâÿüÚ" + webhook_signature_algorithm: + name: X-Lago-Signature-Algorithm + in: header + description: Algorithm used to generate the signature + required: true + schema: + type: string + enum: + - jwt + - hmac + example: hmac + webhook_unique_key: + 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 schemas: AddOnBaseInput: type: object diff --git a/src/parameters/_index.yaml b/src/parameters/_index.yaml index 97143bd..2d5f7be 100644 --- a/src/parameters/_index.yaml +++ b/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" diff --git a/src/parameters/webhook_signature.yaml b/src/parameters/webhook_signature.yaml new file mode 100644 index 0000000..3c29b09 --- /dev/null +++ b/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" diff --git a/src/parameters/webhook_signature_algorithm.yaml b/src/parameters/webhook_signature_algorithm.yaml new file mode 100644 index 0000000..6e3d35e --- /dev/null +++ b/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 diff --git a/src/parameters/webhook_unique_key.yaml b/src/parameters/webhook_unique_key.yaml new file mode 100644 index 0000000..494ecf2 --- /dev/null +++ b/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" diff --git a/src/webhooks/credit_note_created.yaml b/src/webhooks/credit_note_created.yaml index a66b22f..bd44ddf 100644 --- a/src/webhooks/credit_note_created.yaml +++ b/src/webhooks/credit_note_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/credit_note_generated.yaml b/src/webhooks/credit_note_generated.yaml index 4995ddc..2a62f53 100644 --- a/src/webhooks/credit_note_generated.yaml +++ b/src/webhooks/credit_note_generated.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/credit_note_provider_refund_failure.yaml b/src/webhooks/credit_note_provider_refund_failure.yaml index 8ff5496..3eaa0b3 100644 --- a/src/webhooks/credit_note_provider_refund_failure.yaml +++ b/src/webhooks/credit_note_provider_refund_failure.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_accounting_provider_created.yaml b/src/webhooks/customer_accounting_provider_created.yaml index af1a333..4b0f8c6 100644 --- a/src/webhooks/customer_accounting_provider_created.yaml +++ b/src/webhooks/customer_accounting_provider_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_accounting_provider_error.yaml b/src/webhooks/customer_accounting_provider_error.yaml index 807e37c..5653b00 100644 --- a/src/webhooks/customer_accounting_provider_error.yaml +++ b/src/webhooks/customer_accounting_provider_error.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_checkout_url_generated.yaml b/src/webhooks/customer_checkout_url_generated.yaml index c8a16b4..5012611 100644 --- a/src/webhooks/customer_checkout_url_generated.yaml +++ b/src/webhooks/customer_checkout_url_generated.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_created.yaml b/src/webhooks/customer_created.yaml index f1cd7ba..edc3ec9 100644 --- a/src/webhooks/customer_created.yaml +++ b/src/webhooks/customer_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_crm_provider_created.yaml b/src/webhooks/customer_crm_provider_created.yaml index 988c83c..dcd2016 100644 --- a/src/webhooks/customer_crm_provider_created.yaml +++ b/src/webhooks/customer_crm_provider_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_crm_provider_error.yaml b/src/webhooks/customer_crm_provider_error.yaml index 5ec37fe..b300d91 100644 --- a/src/webhooks/customer_crm_provider_error.yaml +++ b/src/webhooks/customer_crm_provider_error.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_payment_provider_created.yaml b/src/webhooks/customer_payment_provider_created.yaml index ed21cab..af021f5 100644 --- a/src/webhooks/customer_payment_provider_created.yaml +++ b/src/webhooks/customer_payment_provider_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_payment_provider_error.yaml b/src/webhooks/customer_payment_provider_error.yaml index f9a8006..2be263a 100644 --- a/src/webhooks/customer_payment_provider_error.yaml +++ b/src/webhooks/customer_payment_provider_error.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_tax_provider_error.yaml b/src/webhooks/customer_tax_provider_error.yaml index 72d167e..128c5bd 100644 --- a/src/webhooks/customer_tax_provider_error.yaml +++ b/src/webhooks/customer_tax_provider_error.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_updated.yaml b/src/webhooks/customer_updated.yaml index 0adfaee..c4d3da3 100644 --- a/src/webhooks/customer_updated.yaml +++ b/src/webhooks/customer_updated.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/customer_vies_check.yaml b/src/webhooks/customer_vies_check.yaml index 5d8d910..71d93b4 100644 --- a/src/webhooks/customer_vies_check.yaml +++ b/src/webhooks/customer_vies_check.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/event_error.yaml b/src/webhooks/event_error.yaml index 29866b1..19bbe96 100644 --- a/src/webhooks/event_error.yaml +++ b/src/webhooks/event_error.yaml @@ -1,6 +1,10 @@ post: deprecated: true 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: diff --git a/src/webhooks/events_errors.yaml b/src/webhooks/events_errors.yaml index c249daf..484b0e1 100644 --- a/src/webhooks/events_errors.yaml +++ b/src/webhooks/events_errors.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/fee_created.yaml b/src/webhooks/fee_created.yaml index f3c1a41..ed86e32 100644 --- a/src/webhooks/fee_created.yaml +++ b/src/webhooks/fee_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/fee_tax_provider_error.yaml b/src/webhooks/fee_tax_provider_error.yaml index b733109..cbb3a65 100644 --- a/src/webhooks/fee_tax_provider_error.yaml +++ b/src/webhooks/fee_tax_provider_error.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/integration_provider_error.yaml b/src/webhooks/integration_provider_error.yaml index a186a29..7f19612 100644 --- a/src/webhooks/integration_provider_error.yaml +++ b/src/webhooks/integration_provider_error.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_add_on_added.yaml b/src/webhooks/invoice_add_on_added.yaml index 20966ec..d197edd 100644 --- a/src/webhooks/invoice_add_on_added.yaml +++ b/src/webhooks/invoice_add_on_added.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_created.yaml b/src/webhooks/invoice_created.yaml index 17c043f..8fdcac1 100644 --- a/src/webhooks/invoice_created.yaml +++ b/src/webhooks/invoice_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_drafted.yaml b/src/webhooks/invoice_drafted.yaml index a15ebae..e4d1888 100644 --- a/src/webhooks/invoice_drafted.yaml +++ b/src/webhooks/invoice_drafted.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_generated.yaml b/src/webhooks/invoice_generated.yaml index ed4b3d2..c30a11c 100644 --- a/src/webhooks/invoice_generated.yaml +++ b/src/webhooks/invoice_generated.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_one_off_created.yaml b/src/webhooks/invoice_one_off_created.yaml index 5a2f0b6..9e558be 100644 --- a/src/webhooks/invoice_one_off_created.yaml +++ b/src/webhooks/invoice_one_off_created.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_paid_credit_added.yaml b/src/webhooks/invoice_paid_credit_added.yaml index dba3103..84af737 100644 --- a/src/webhooks/invoice_paid_credit_added.yaml +++ b/src/webhooks/invoice_paid_credit_added.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_payment_dispute_lost.yaml b/src/webhooks/invoice_payment_dispute_lost.yaml index 89eecdd..0b29608 100644 --- a/src/webhooks/invoice_payment_dispute_lost.yaml +++ b/src/webhooks/invoice_payment_dispute_lost.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_payment_failure.yaml b/src/webhooks/invoice_payment_failure.yaml index 3410f27..4fc4b6c 100644 --- a/src/webhooks/invoice_payment_failure.yaml +++ b/src/webhooks/invoice_payment_failure.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_payment_overdue.yaml b/src/webhooks/invoice_payment_overdue.yaml index 6f666c8..d4aaa19 100644 --- a/src/webhooks/invoice_payment_overdue.yaml +++ b/src/webhooks/invoice_payment_overdue.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_payment_status_updated.yaml b/src/webhooks/invoice_payment_status_updated.yaml index c4dc169..e35dfda 100644 --- a/src/webhooks/invoice_payment_status_updated.yaml +++ b/src/webhooks/invoice_payment_status_updated.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_resynced.yaml b/src/webhooks/invoice_resynced.yaml index 4ad0f2e..4767628 100644 --- a/src/webhooks/invoice_resynced.yaml +++ b/src/webhooks/invoice_resynced.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/invoice_voided.yaml b/src/webhooks/invoice_voided.yaml index ad3b7bb..4bda5d3 100644 --- a/src/webhooks/invoice_voided.yaml +++ b/src/webhooks/invoice_voided.yaml @@ -1,5 +1,9 @@ post: 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: diff --git a/src/webhooks/payment_provider_error.yaml b/src/webhooks/payment_provider_error.yaml index 26ebe2b..5e42667 100644 --- a/src/webhooks/payment_provider_error.yaml +++ b/src/webhooks/payment_provider_error.yaml @@ -1,5 +1,9 @@ post: description: An error was raised by 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 payment provider and of the error content: diff --git a/src/webhooks/payment_request_created.yaml b/src/webhooks/payment_request_created.yaml index afc97a2..0eb8146 100644 --- a/src/webhooks/payment_request_created.yaml +++ b/src/webhooks/payment_request_created.yaml @@ -1,5 +1,9 @@ post: description: An new payment request 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 payment request content: diff --git a/src/webhooks/payment_request_payment_failure.yaml b/src/webhooks/payment_request_payment_failure.yaml index df4d395..2fc9ffd 100644 --- a/src/webhooks/payment_request_payment_failure.yaml +++ b/src/webhooks/payment_request_payment_failure.yaml @@ -1,5 +1,9 @@ post: description: A payment attempt for a payment request 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 payment request and of the provider error content: diff --git a/src/webhooks/payment_request_payment_status_updated.yaml b/src/webhooks/payment_request_payment_status_updated.yaml index c2d9613..23ff0c6 100644 --- a/src/webhooks/payment_request_payment_status_updated.yaml +++ b/src/webhooks/payment_request_payment_status_updated.yaml @@ -1,5 +1,9 @@ post: 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 payment request content: diff --git a/src/webhooks/payment_requires_action.yaml b/src/webhooks/payment_requires_action.yaml index 8d3d540..5d5e268 100644 --- a/src/webhooks/payment_requires_action.yaml +++ b/src/webhooks/payment_requires_action.yaml @@ -1,5 +1,9 @@ post: description: An action is required to process a payment + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the payment and of the required action content: diff --git a/src/webhooks/subscription_started.yaml b/src/webhooks/subscription_started.yaml index a1e1751..3885ed3 100644 --- a/src/webhooks/subscription_started.yaml +++ b/src/webhooks/subscription_started.yaml @@ -1,5 +1,9 @@ post: description: An subscription has started + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the subscription content: diff --git a/src/webhooks/subscription_terminated.yaml b/src/webhooks/subscription_terminated.yaml index ddb7604..92b1957 100644 --- a/src/webhooks/subscription_terminated.yaml +++ b/src/webhooks/subscription_terminated.yaml @@ -1,5 +1,9 @@ post: description: A subscription has been terminated + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the subscription content: diff --git a/src/webhooks/subscription_termination_alert.yaml b/src/webhooks/subscription_termination_alert.yaml index 3525dd3..28c9344 100644 --- a/src/webhooks/subscription_termination_alert.yaml +++ b/src/webhooks/subscription_termination_alert.yaml @@ -1,5 +1,9 @@ post: description: A subscription will be terminated in the future + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the subscription content: diff --git a/src/webhooks/subscription_trial_ended.yaml b/src/webhooks/subscription_trial_ended.yaml index db58c05..1292c7c 100644 --- a/src/webhooks/subscription_trial_ended.yaml +++ b/src/webhooks/subscription_trial_ended.yaml @@ -1,5 +1,9 @@ post: description: A subscription trial period has ended + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the subscription content: diff --git a/src/webhooks/subscription_usage_threshold_reached.yaml b/src/webhooks/subscription_usage_threshold_reached.yaml index e989285..03dc585 100644 --- a/src/webhooks/subscription_usage_threshold_reached.yaml +++ b/src/webhooks/subscription_usage_threshold_reached.yaml @@ -1,5 +1,9 @@ post: description: A usage threshold has been reached by a subscription + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the subscription and of the reached threshold content: diff --git a/src/webhooks/wallet_depleted_ongoing_balance.yaml b/src/webhooks/wallet_depleted_ongoing_balance.yaml index ba9ef29..8193e01 100644 --- a/src/webhooks/wallet_depleted_ongoing_balance.yaml +++ b/src/webhooks/wallet_depleted_ongoing_balance.yaml @@ -1,5 +1,9 @@ post: description: The balance of a wallet has been depleted + parameters: + - $ref: "../parameters/webhook_signature.yaml" + - $ref: "../parameters/webhook_signature_algorithm.yaml" + - $ref: "../parameters/webhook_unique_key.yaml" requestBody: description: Details of the wallet content: diff --git a/src/webhooks/wallet_transaction_created.yaml b/src/webhooks/wallet_transaction_created.yaml index 7d396e7..befc946 100644 --- a/src/webhooks/wallet_transaction_created.yaml +++ b/src/webhooks/wallet_transaction_created.yaml @@ -1,5 +1,9 @@ post: description: A new wallet transaction 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 wallet transaction content: diff --git a/src/webhooks/wallet_transaction_payment_failure.yaml b/src/webhooks/wallet_transaction_payment_failure.yaml index b68187d..9731684 100644 --- a/src/webhooks/wallet_transaction_payment_failure.yaml +++ b/src/webhooks/wallet_transaction_payment_failure.yaml @@ -1,5 +1,9 @@ post: description: A payment attempt for a wallet transaction 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 wallet transaction and of the provider error content: diff --git a/src/webhooks/wallet_transaction_updated.yaml b/src/webhooks/wallet_transaction_updated.yaml index 47955e3..5cbe65b 100644 --- a/src/webhooks/wallet_transaction_updated.yaml +++ b/src/webhooks/wallet_transaction_updated.yaml @@ -1,5 +1,9 @@ post: description: A wallet transaction 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 wallet transaction content: