Struct lexoffice::model::event_subscriptions::EventSubscription

pub struct EventSubscription {
    pub subscription_id: ReadOnly<Uuid>,
    pub organization_id: ReadOnly<Uuid>,
    pub created_date: ReadOnly<DateTime>,
    pub event_type: EventType,
    pub callback_url: String,
}

{
  "subscriptionId": "4d43ad14-671d-4e0c-fd4b-2fd8cc117eff",
  "organizationId": "aa93e8a8-2aa3-470b-b914-caad8a255dd8",
  "createdDate": "2018-04-11T12:15:00.000+02:00",
  "eventType": "contact.changed",
  "callbackUrl": "https://example.org/webhook"
}

Fields

subscription_id: ReadOnly<Uuid>

Unique id of the event subscription generated on creation by lexoffice.
Read-only.

organization_id: ReadOnly<Uuid>

Unique id of the organization the event subscription belongs to.
Read-only.

created_date: ReadOnly<DateTime>

The instant of time when the event subscription was created by lexoffice in format yyyy-MM-ddTHH:mm:ss.SSSXXX as described in RFC 3339/ISO 8601 (e.g. 2020-02-21T00:00:00.000+01:00).
Read-only.

event_type: EventType

The event type is a combined key which defines the resource and its event name you are subscribing to. All available events receivable via the API can be taken from the table Event Types.

callback_url: String

When a resource entity triggers an event, the callback url is used to notify the subscriber about it. The payload of the callback is described in Webhook Callback Properties.

Implementations

impl EventSubscription

pub fn builder() -> EventSubscriptionBuilder<((), ())>

Create a builder for building EventSubscription. On the builder, call .event_type(...), .callback_url(...) to set the values of the fields. Finally, call .build() to create the instance of EventSubscription.

Trait Implementations

impl Clone for EventSubscription

fn clone(&self) -> EventSubscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventSubscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventSubscription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl HasId for EventSubscription

fn id(&self) -> &ReadOnly<Uuid>

gets the id from an object.

impl PartialEq<EventSubscription> for EventSubscription

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for EventSubscription

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 EventSubscription