Struct WebhookDefinition

pub struct WebhookDefinition {
    pub authentication: String,
    pub authentication_configuration: WebhookAuthConfiguration,
    pub filters: Vec<WebhookFilterRule>,
    pub name: String,
    pub target_action: String,
    pub target_pipeline: String,
}

Represents information about a webhook and its definition.

Fields

authentication: String

Supported options are GITHUBHMAC, IP, and UNAUTHENTICATED.

• For information about the authentication scheme implemented by GITHUBHMAC, see Securing your webhooks on the GitHub Developer website.

• IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

authentication_configuration: WebhookAuthConfiguration

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

filters: Vec<WebhookFilterRule>

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

name: String

The name of the webhook.

target_action: String

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

target_pipeline: String

The name of the pipeline you want to connect to the webhook.

Trait Implementations

impl Clone for WebhookDefinition

fn clone(&self) -> WebhookDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookDefinition

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

Formats the value using the given formatter.

impl Default for WebhookDefinition

fn default() -> WebhookDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebhookDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebhookDefinition

fn eq(&self, other: &WebhookDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WebhookDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebhookDefinition