Struct WebHook 

pub struct WebHook {
    pub id: Option<Uuid>,
    pub name: String,
    pub description: Option<String>,
    pub url: String,
    pub trigger: WebHookTrigger,
    pub is_active: bool,
    pub created: DateTime<Local>,
    pub created_by: Option<WrittenBy>,
    pub updated: Option<DateTime<Local>>,
    pub updated_by: Option<WrittenBy>,
    /* private fields */
}

Fields

id: Option<Uuid>

The webhook id

name: String

The webhook name

description: Option<String>

The webhook description

url: String

The webhook url

trigger: WebHookTrigger

The webhook trigger

is_active: bool

The webhook is active

created: DateTime<Local>

The webhook created date

created_by: Option<WrittenBy>

The webhook created by

The ID of the account that created the webhook. This is used for auditing purposes.

updated: Option<DateTime<Local>>

The webhook updated date

updated_by: Option<WrittenBy>

The webhook updated by

The ID of the account that updated the webhook. This is used for auditing purposes.

Implementations

impl WebHook

pub fn new( name: String, description: Option<String>, url: String, trigger: WebHookTrigger, secret: Option<HttpSecret>, created_by: Option<WrittenBy>, ) -> Self

pub async fn new_encrypted( name: String, description: Option<String>, url: String, trigger: WebHookTrigger, secret: Option<HttpSecret>, config: AccountLifeCycle, created_by: Option<WrittenBy>, ) -> Result<Self, MappedErrors>

pub fn redact_secret_token(&mut self)

pub fn get_secret(&self) -> Option<HttpSecret>

pub async fn set_secret( &mut self, secret: HttpSecret, config: AccountLifeCycle, updated_by: Option<WrittenBy>, ) -> Result<(), MappedErrors>

Trait Implementations

impl Clone for WebHook

fn clone(&self) -> WebHook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for WebHook

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for WebHook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebHook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WebHook

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for WebHook

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.