Struct WebhookSubscriptionResponse 

pub struct WebhookSubscriptionResponse {
    pub created_at: DateTime<Utc>,
    pub description: Option<String>,
    pub event_types: Vec<String>,
    pub is_enabled: bool,
    pub label_key: Option<String>,
    pub label_value: Option<String>,
    pub labels: HashMap<String, String>,
    pub metadata: Option<WebhookSubscriptionResponseMetadata>,
    pub secret: Uuid,
    pub subscription_id: Uuid,
    pub target: WebhookTarget,
}

Response containing webhook subscription details.

JSON schema

{
 "description": "Response containing webhook subscription details.",
 "examples": [
   {
     "createdAt": "2025-11-12T09:19:52.051Z",
     "description": "USDC Transfer events to specific address.",
     "eventTypes": [
       "onchain.activity.detected"
     ],
     "isEnabled": true,
     "labelKey": "event_name",
     "labelValue": "Transfer",
     "labels": {
       "contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
       "event_name": "Transfer",
       "network": "base-mainnet",
       "transaction_to": "0xf5042e6ffac5a625d4e7848e0b01373d8eb9e222"
     },
     "metadata": {
       "secret": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
     },
     "secret": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
     "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
     "target": {
       "url": "https://api.example.com/webhooks"
     }
   }
 ],
 "type": "object",
 "required": [
   "createdAt",
   "eventTypes",
   "isEnabled",
   "secret",
   "subscriptionId",
   "target"
 ],
 "properties": {
   "createdAt": {
     "description": "When the subscription was created.",
     "examples": [
       "2025-01-15T10:30:00Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "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\").\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. Present when subscription uses traditional single-label format.\n",
     "examples": [
       "contract_address"
     ],
     "type": "string"
   },
   "labelValue": {
     "description": "Label value for filtering events. Present when subscription uses traditional single-label format.\n",
     "examples": [
       "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
     ],
     "type": "string"
   },
   "labels": {
     "description": "Multi-label filters using total overlap logic. Total overlap means the subscription only triggers when events contain ALL these key-value pairs.\nPresent when subscription uses multi-label format.\n",
     "examples": [
       {
         "contract_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
         "env": "dev",
         "team": "payments"
       }
     ],
     "type": "object",
     "additionalProperties": {
       "type": "string"
     }
   },
   "metadata": {
     "description": "Additional metadata for the subscription.",
     "examples": [
       {
         "secret": "123e4567-e89b-12d3-a456-426614174000"
       }
     ],
     "type": "object",
     "properties": {
       "secret": {
         "description": "Use the root-level `secret` field instead. Maintained for backward compatibility only.",
         "deprecated": true,
         "examples": [
           "123e4567-e89b-12d3-a456-426614174000"
         ],
         "type": "string",
         "format": "uuid"
       }
     }
   },
   "secret": {
     "description": "Secret for webhook signature validation.",
     "examples": [
       "123e4567-e89b-12d3-a456-426614174000"
     ],
     "type": "string",
     "format": "uuid"
   },
   "subscriptionId": {
     "description": "Unique identifier for the subscription.",
     "examples": [
       "123e4567-e89b-12d3-a456-426614174000"
     ],
     "type": "string",
     "format": "uuid"
   },
   "target": {
     "$ref": "#/components/schemas/WebhookTarget"
   }
 }
}

Fields

created_at: DateTime<Utc>

When the subscription was created.

description: Option<String>

Description of the webhook subscription.

event_types: Vec<String>

Types of events to subscribe to. Event types follow a three-part dot-separated format: service.resource.verb (e.g., “onchain.activity.detected”, “wallet.activity.detected”, “onramp.transaction.created”).

is_enabled: bool

Whether the subscription is enabled.

label_key: Option<String>

Label key for filtering events. Present when subscription uses traditional single-label format.

label_value: Option<String>

Label value for filtering events. Present when subscription uses traditional single-label format.

labels: HashMap<String, String>

Multi-label filters using total overlap logic. Total overlap means the subscription only triggers when events contain ALL these key-value pairs. Present when subscription uses multi-label format.

metadata: Option<WebhookSubscriptionResponseMetadata>

secret: Uuid

Secret for webhook signature validation.

subscription_id: Uuid

Unique identifier for the subscription.

target: WebhookTarget

Implementations

impl WebhookSubscriptionResponse

pub fn builder() -> WebhookSubscriptionResponse

Trait Implementations

impl Clone for WebhookSubscriptionResponse

fn clone(&self) -> WebhookSubscriptionResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebhookSubscriptionResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebhookSubscriptionResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&WebhookSubscriptionResponse> for WebhookSubscriptionResponse

fn from(value: &WebhookSubscriptionResponse) -> Self

Converts to this type from the input type.

impl From<WebhookSubscriptionResponse> for WebhookSubscriptionResponse

fn from(value: WebhookSubscriptionResponse) -> Self

Converts to this type from the input type.

impl Serialize for WebhookSubscriptionResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<WebhookSubscriptionResponse> for WebhookSubscriptionResponse

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: WebhookSubscriptionResponse) -> Result<Self, ConversionError>

Performs the conversion.