From 57ae063045a8255ed4ac311832738a56235e33cd Mon Sep 17 00:00:00 2001 From: Rina Sergeeva Date: Tue, 10 Feb 2026 03:03:19 +0900 Subject: [PATCH] add `event_types` and `name` attributes to `WebhookEndpoint` resource --- openapi.yaml | 48 ++++++++++++++++++++- src/schemas/WebhookEndpointCreateInput.yaml | 12 ++++++ src/schemas/WebhookEndpointObject.yaml | 18 +++++++- src/schemas/WebhookEndpointUpdateInput.yaml | 12 ++++++ 4 files changed, 86 insertions(+), 4 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index be7d1d0f..29684086 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -18825,8 +18825,8 @@ components: example: 1a901a90-1a90-1a90-1a90-1a901a901a90 webhook_url: type: string - description: The name of the wallet. - example: Prepaid + description: The URL of the webhook endpoint. + example: https://foo.bar signature_algo: type: string description: The signature algo for the webhook. @@ -18834,6 +18834,22 @@ components: enum: - jwt - hmac + name: + type: + - string + - 'null' + description: The name of the webhook. + example: EC2-production + event_types: + type: + - array + - 'null' + description: A list of event types that will trigger the webhook. + items: + type: string + example: + - invoice.voided + - customer.created created_at: type: string format: date-time @@ -18873,6 +18889,20 @@ components: - jwt - hmac - null + name: + type: string + description: The name of the webhook. + example: EC2-production + event_types: + type: + - array + - 'null' + description: A list of event types that will trigger the webhook. + items: + type: string + example: + - invoice.voided + - customer.created WebhookEndpoint: type: object required: @@ -18902,6 +18932,20 @@ components: - jwt - hmac - null + name: + type: string + description: The name of the webhook. + example: EC2-production + event_types: + type: + - array + - 'null' + description: A list of event types that will trigger the webhook. + items: + type: string + example: + - invoice.voided + - customer.created TriggeredAlertObject: type: object required: diff --git a/src/schemas/WebhookEndpointCreateInput.yaml b/src/schemas/WebhookEndpointCreateInput.yaml index 74a89c62..5a746d5c 100644 --- a/src/schemas/WebhookEndpointCreateInput.yaml +++ b/src/schemas/WebhookEndpointCreateInput.yaml @@ -19,3 +19,15 @@ properties: - jwt - hmac - null + name: + type: string + description: The name of the webhook. + example: EC2-production + event_types: + type: + - array + - "null" + description: A list of event types that will trigger the webhook. + items: + type: string + example: ["invoice.voided", "customer.created"] diff --git a/src/schemas/WebhookEndpointObject.yaml b/src/schemas/WebhookEndpointObject.yaml index 9a1d53c8..604de4c4 100644 --- a/src/schemas/WebhookEndpointObject.yaml +++ b/src/schemas/WebhookEndpointObject.yaml @@ -17,8 +17,8 @@ properties: example: '1a901a90-1a90-1a90-1a90-1a901a901a90' webhook_url: type: string - description: The name of the wallet. - example: 'Prepaid' + description: The URL of the webhook endpoint. + example: "https://foo.bar" signature_algo: type: string description: The signature algo for the webhook. @@ -26,6 +26,20 @@ properties: enum: - jwt - hmac + name: + type: + - string + - 'null' + description: The name of the webhook. + example: EC2-production + event_types: + type: + - array + - 'null' + description: A list of event types that will trigger the webhook. + items: + type: string + example: ['invoice.voided', 'customer.created'] created_at: type: string format: 'date-time' diff --git a/src/schemas/WebhookEndpointUpdateInput.yaml b/src/schemas/WebhookEndpointUpdateInput.yaml index 74a89c62..5a746d5c 100644 --- a/src/schemas/WebhookEndpointUpdateInput.yaml +++ b/src/schemas/WebhookEndpointUpdateInput.yaml @@ -19,3 +19,15 @@ properties: - jwt - hmac - null + name: + type: string + description: The name of the webhook. + example: EC2-production + event_types: + type: + - array + - "null" + description: A list of event types that will trigger the webhook. + items: + type: string + example: ["invoice.voided", "customer.created"]