Enum twitch_api2::eventsub::Payload

pub enum Payload {
    VerificationRequest(VerificationRequest),
    ChannelUpdateV1(NotificationPayload<ChannelUpdateV1>),
    ChannelFollowV1(NotificationPayload<ChannelFollowV1>),
    ChannelSubscribeV1(NotificationPayload<ChannelSubscribeV1>),
    ChannelCheerV1(NotificationPayload<ChannelCheerV1>),
    ChannelBanV1(NotificationPayload<ChannelBanV1>),
    ChannelUnbanV1(NotificationPayload<ChannelUnbanV1>),
    ChannelPointsCustomRewardAddV1(NotificationPayload<ChannelPointsCustomRewardAddV1>),
    ChannelPointsCustomRewardUpdateV1(NotificationPayload<ChannelPointsCustomRewardUpdateV1>),
    ChannelPointsCustomRewardRemoveV1(NotificationPayload<ChannelPointsCustomRewardRemoveV1>),
    ChannelPointsCustomRewardRedemptionAddV1(NotificationPayload<ChannelPointsCustomRewardRedemptionAddV1>),
    ChannelPointsCustomRewardRedemptionUpdateV1(NotificationPayload<ChannelPointsCustomRewardRedemptionUpdateV1>),
    ChannelHypeTrainBeginV1(NotificationPayload<ChannelHypeTrainBeginV1>),
    ChannelHypeTrainProgressV1(NotificationPayload<ChannelHypeTrainProgressV1>),
    ChannelHypeTrainEndV1(NotificationPayload<ChannelHypeTrainEndV1>),
    StreamOnlineV1(NotificationPayload<StreamOnlineV1>),
    StreamOfflineV1(NotificationPayload<StreamOfflineV1>),
    UserUpdateV1(NotificationPayload<UserUpdateV1>),
    UserAuthorizationRevokeV1(NotificationPayload<UserAuthorizationRevokeV1>),
    ChannelRaidV1(NotificationPayload<ChannelRaidV1>),
}

This is supported on crate feature eventsub only.

Subscription payload. Received on events. Enumerates all possible NotificationPayloads

Use Payload::parse to construct

Variants

VerificationRequest(VerificationRequest)

Webhook Callback Verification

ChannelUpdateV1(NotificationPayload<ChannelUpdateV1>)

Channel Update V1 Event

ChannelFollowV1(NotificationPayload<ChannelFollowV1>)

Channel Follow V1 Event

ChannelSubscribeV1(NotificationPayload<ChannelSubscribeV1>)

Channel Subscribe V1 Event

ChannelCheerV1(NotificationPayload<ChannelCheerV1>)

Channel Cheer V1 Event

ChannelBanV1(NotificationPayload<ChannelBanV1>)

Channel Ban V1 Event

ChannelUnbanV1(NotificationPayload<ChannelUnbanV1>)

Channel Unban V1 Event

ChannelPointsCustomRewardAddV1(NotificationPayload<ChannelPointsCustomRewardAddV1>)

Channel Points Custom Reward Add V1 Event

ChannelPointsCustomRewardUpdateV1(NotificationPayload<ChannelPointsCustomRewardUpdateV1>)

Channel Points Custom Reward Update V1 Event

ChannelPointsCustomRewardRemoveV1(NotificationPayload<ChannelPointsCustomRewardRemoveV1>)

Channel Points Custom Reward Remove V1 Event

ChannelPointsCustomRewardRedemptionAddV1(NotificationPayload<ChannelPointsCustomRewardRedemptionAddV1>)

Channel Points Custom Reward Redemption Add V1 Event

ChannelPointsCustomRewardRedemptionUpdateV1(NotificationPayload<ChannelPointsCustomRewardRedemptionUpdateV1>)

Channel Points Custom Reward Redemption Update V1 Event

ChannelHypeTrainBeginV1(NotificationPayload<ChannelHypeTrainBeginV1>)

Channel Hype Train Begin V1 Event

ChannelHypeTrainProgressV1(NotificationPayload<ChannelHypeTrainProgressV1>)

Channel Hype Train Progress V1 Event

ChannelHypeTrainEndV1(NotificationPayload<ChannelHypeTrainEndV1>)

Channel Hype Train End V1 Event

StreamOnlineV1(NotificationPayload<StreamOnlineV1>)

StreamOnline V1 Event

StreamOfflineV1(NotificationPayload<StreamOfflineV1>)

StreamOffline V1 Event

UserUpdateV1(NotificationPayload<UserUpdateV1>)

User Update V1 Event

UserAuthorizationRevokeV1(NotificationPayload<UserAuthorizationRevokeV1>)

User Authorization Revoke V1 Event

ChannelRaidV1(NotificationPayload<ChannelRaidV1>)

Channel Raid V1 Event

Implementations

impl Payload

pub fn parse(source: &str) -> Result<Payload, PayloadParseError>

Parse string slice as a Payload

pub fn parse_http(
    request: &Request<Vec<u8>>
) -> Result<Payload, PayloadParseError>

Parse http post request as a Payload.

pub fn verify_payload(request: &Request<Vec<u8>>, secret: &[u8]) -> bool

This is supported on crate feature hmac only.

Verify that this payload is authentic using HMAC-SHA256.

HMAC key is secret, HMAC message is a concatenation of Twitch-Eventsub-Message-Id header, Twitch-Eventsub-Message-Timestamp header and the request body. HMAC signature is Twitch-Eventsub-Message-Signature header

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Payload

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq<Payload> for Payload

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

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

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

This method tests for !=.

impl Serialize for Payload

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 Payload