Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.02 KB

create-webhook-subscription-request.md

File metadata and controls

35 lines (26 loc) · 1.02 KB

Create Webhook Subscription Request

Creates a Subscription.

Structure

CreateWebhookSubscriptionRequest

Fields

Name Type Tags Description
IdempotencyKey string Optional A unique string that identifies the CreateWebhookSubscription request.
Constraints: Maximum Length: 45
Subscription WebhookSubscription Required Represents the details of a webhook subscription, including notification URL,
event types, and signature key.

Example (as JSON)

{
  "idempotency_key": "63f84c6c-2200-4c99-846c-2670a1311fbf",
  "subscription": {
    "api_version": "2021-12-15",
    "event_types": [
      "payment.created",
      "payment.updated"
    ],
    "name": "Example Webhook Subscription",
    "notification_url": "https://example-webhook-url.com",
    "id": "id4",
    "enabled": false
  }
}