Struct CreateWebhookRequest 

pub struct CreateWebhookRequest {
    pub channels: Vec<WebhookChannel>,
    pub description: Option<String>,
    pub disabled: Option<bool>,
    pub filter: Option<String>,
    pub filter_types: Vec<String>,
    pub metadata: Map<String, Value>,
    pub rate_limit: Option<i32>,
    pub secret: Option<String>,
    pub url: String,
}

Request to create a webhook endpoint

JSON schema

{
 "description": "Request to create a webhook endpoint",
 "type": "object",
 "required": [
   "url"
 ],
 "properties": {
   "channels": {
     "description": "Webhook event channels to subscribe to",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/WebhookChannel"
     }
   },
   "description": {
     "description": "Endpoint description",
     "examples": [
       "Webhook description"
     ],
     "type": "string"
   },
   "disabled": {
     "description": "Whether the endpoint is disabled",
     "examples": [
       false
     ],
     "type": "boolean"
   },
   "filter": {
     "description": "Event filter configuration",
     "type": "string"
   },
   "filterTypes": {
     "description": "Event type filters",
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "metadata": {
     "description": "Endpoint metadata",
     "examples": [
       {
         "key": "value"
       }
     ],
     "type": "object",
     "additionalProperties": {}
   },
   "rateLimit": {
     "description": "Rate limit for the endpoint",
     "examples": [
       1000
     ],
     "type": "integer",
     "format": "int32",
     "minimum": 0.0
   },
   "secret": {
     "description": "Endpoint signing secret",
     "type": "string"
   },
   "url": {
     "description": "Webhook destination URL",
     "examples": [
       "https://example.com"
     ],
     "type": "string"
   }
 }
}

Fields

channels: Vec<WebhookChannel>

Webhook event channels to subscribe to

description: Option<String>

Endpoint description

disabled: Option<bool>

Whether the endpoint is disabled

filter: Option<String>

Event filter configuration

filter_types: Vec<String>

Event type filters

metadata: Map<String, Value>

Endpoint metadata

rate_limit: Option<i32>

Rate limit for the endpoint

secret: Option<String>

Endpoint signing secret

url: String

Webhook destination URL

Implementations

impl CreateWebhookRequest

pub fn builder() -> CreateWebhookRequest

Trait Implementations

impl Clone for CreateWebhookRequest

fn clone(&self) -> CreateWebhookRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWebhookRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateWebhookRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CreateWebhookRequest> for CreateWebhookRequest

fn from(value: &CreateWebhookRequest) -> Self

Converts to this type from the input type.

impl From<CreateWebhookRequest> for CreateWebhookRequest

fn from(value: CreateWebhookRequest) -> Self

Converts to this type from the input type.

impl Serialize for CreateWebhookRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateWebhookRequest> for CreateWebhookRequest

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.