Struct AddWebhookRequest

pub struct AddWebhookRequest {
    pub subscription_url: String,
    pub event_action: EventAction,
    pub event_object: EventObject,
    pub user_id: Option<i32>,
    pub http_auth_user: Option<String>,
    pub http_auth_password: Option<String>,
    pub version: Option<Version>,
}

Fields

subscription_url: String

A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url and the chosen URL must not redirect to another link.

event_action: EventAction

The type of action to receive notifications about. Wildcard will match all supported actions.

event_object: EventObject

The type of object to receive notifications about. Wildcard will match all supported objects.

user_id: Option<i32>

The ID of the user that this webhook will be authorized with. You have the option to use a different user’s user_id. If it is not set, the current user’s user_id will be used. As each webhook event is checked against a user’s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s user_id.

http_auth_user: Option<String>

The HTTP basic auth username of the subscription URL endpoint (if required)

http_auth_password: Option<String>

The HTTP basic auth password of the subscription URL endpoint (if required)

version: Option<Version>

The webhook’s version

Implementations

impl AddWebhookRequest

pub fn new( subscription_url: String, event_action: EventAction, event_object: EventObject, ) -> AddWebhookRequest

Trait Implementations

impl Clone for AddWebhookRequest

fn clone(&self) -> AddWebhookRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddWebhookRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddWebhookRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AddWebhookRequest

fn eq(&self, other: &AddWebhookRequest) -> 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 AddWebhookRequest

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 AddWebhookRequest