cdp_sdk::api::types

Enum WebhookSubscriptionRequestVariant0

pub enum WebhookSubscriptionRequestVariant0 {}

Expand description

WebhookSubscriptionRequestVariant0

JSON schema

{
 "allOf": [
   {
     "type": "object",
     "properties": {
       "description": {
         "description": "Description of the webhook subscription.",
         "examples": [
           "Subscription for token transfer events"
         ],
         "type": "string"
       },
       "eventTypes": {
         "description": "Types of events to subscribe to. Event types follow a three-part dot-separated format:\nservice.resource.verb (e.g., \"onchain.activity.detected\", \"wallet.activity.detected\", \"onramp.transaction.created\").\nThe subscription will only receive events matching these types AND the label filter(s).\n",
         "examples": [
           [
             "onchain.activity.detected"
           ]
         ],
         "type": "array",
         "items": {
           "type": "string"
         }
       },
       "isEnabled": {
         "description": "Whether the subscription is enabled.",
         "examples": [
           true
         ],
         "type": "boolean"
       },
       "labelKey": {
         "description": "Label key for filtering events. Each subscription filters on exactly one (labelKey, labelValue) pair\nin addition to the event types. Only events matching both the event types AND this label filter will be delivered.\nNOTE: Use either (labelKey + labelValue) OR labels, not both.\n",
         "examples": [
           "contract_address"
         ],
         "type": "string"
       },
       "labelValue": {
         "description": "Label value for filtering events. Must correspond to the labelKey (e.g., contract address for contract_address key).\nOnly events with this exact label value will be delivered.\nNOTE: Use either (labelKey + labelValue) OR labels, not both.\n",
         "examples": [
           "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
         ],
         "type": "string"
       },
       "labels": {
         "description": "Multi-label filters using total overlap logic. Total overlap means the subscription will only trigger when\nan event contains ALL the key-value pairs specified here. Additional labels on\nthe event are allowed and will not prevent matching.\nNOTE: Use either labels OR (labelKey + labelValue), not both.\n",
         "examples": [
           {
             "contract_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
             "env": "dev",
             "team": "payments"
           }
         ],
         "type": "object",
         "additionalProperties": {
           "type": "string"
         }
       },
       "metadata": {
         "description": "Additional metadata for the subscription.",
         "examples": [
           {
             "custom_field": "custom_value",
             "webhook_version": "v1"
           }
         ],
         "type": "object",
         "additionalProperties": true
       },
       "target": {
         "$ref": "#/components/schemas/WebhookTarget"
       }
     }
   },
   {
     "title": "Traditional single-label format",
     "not": {
       "required": [
         "labels"
       ]
     },
     "required": [
       "eventTypes",
       "isEnabled",
       "labelKey",
       "labelValue",
       "target"
     ]
   },
   {
     "not": {
       "title": "Multi-label format with total overlap logic",
       "not": {
         "anyOf": [
           {
             "required": [
               "labelKey"
             ]
           },
           {
             "required": [
               "labelValue"
             ]
           }
         ]
       },
       "required": [
         "eventTypes",
         "isEnabled",
         "labels",
         "target"
       ]
     }
   }
 ]
}