Struct PingEvent

pub struct PingEvent {
    pub hook: PingEventHook,
    pub hook_id: i64,
    pub organization: Option<Organization>,
    pub repository: Option<Repository>,
    pub sender: Option<User>,
    pub zen: String,
}

PingEvent

JSON schema

{
 "title": "ping event",
 "type": "object",
 "required": [
   "hook",
   "hook_id",
   "zen"
 ],
 "properties": {
   "hook": {
     "description": "The [webhook configuration](https://docs.github.com/en/rest/reference/repos#get-a-repository-webhook).",
     "type": "object",
     "required": [
       "active",
       "config",
       "created_at",
       "deliveries_url",
       "events",
       "id",
       "name",
       "ping_url",
       "type",
       "updated_at",
       "url"
     ],
     "properties": {
       "active": {
         "type": "boolean"
       },
       "app_id": {
         "description": "When you register a new GitHub App, GitHub sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](https://docs.github.com/en/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps) an app.",
         "type": "integer"
       },
       "config": {
         "description": "Configuration object of the webhook",
         "type": "object",
         "required": [
           "content_type",
           "insecure_ssl",
           "url"
         ],
         "properties": {
           "content_type": {
             "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
             "type": "string",
             "enum": [
               "json",
               "form"
             ]
           },
           "insecure_ssl": {
             "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`.",
             "type": "string",
             "enum": [
               "0",
               "1"
             ]
           },
           "secret": {
             "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).",
             "type": "string"
           },
           "url": {
             "description": "The URL to which the payloads will be delivered.",
             "type": "string",
             "format": "uri"
           }
         },
         "additionalProperties": false
       },
       "created_at": {
         "type": "string",
         "format": "date-time"
       },
       "deliveries_url": {
         "type": "string",
         "format": "uri"
       },
       "events": {
         "$ref": "#/definitions/webhook-events"
       },
       "id": {
         "type": "integer"
       },
       "last_response": {
         "type": "object",
         "required": [
           "code",
           "message",
           "status"
         ],
         "properties": {
           "code": {
             "type": "null"
           },
           "message": {
             "type": "null"
           },
           "status": {
             "type": "string"
           }
         },
         "additionalProperties": false
       },
       "name": {
         "type": "string"
       },
       "ping_url": {
         "type": "string",
         "format": "uri"
       },
       "test_url": {
         "type": "string",
         "format": "uri"
       },
       "type": {
         "type": "string",
         "enum": [
           "Repository",
           "Organization",
           "App"
         ]
       },
       "updated_at": {
         "type": "string",
         "format": "date-time"
       },
       "url": {
         "type": "string",
         "format": "uri"
       }
     },
     "additionalProperties": false
   },
   "hook_id": {
     "description": "The ID of the webhook that triggered the ping.",
     "type": "integer"
   },
   "organization": {
     "$ref": "#/definitions/organization"
   },
   "repository": {
     "$ref": "#/definitions/repository"
   },
   "sender": {
     "$ref": "#/definitions/user"
   },
   "zen": {
     "type": "string"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

hook: PingEventHook

hook_id: i64

The ID of the webhook that triggered the ping.

organization: Option<Organization>

repository: Option<Repository>

sender: Option<User>

zen: String

Implementations

impl PingEvent

pub fn builder() -> PingEvent

Trait Implementations

impl Clone for PingEvent

fn clone(&self) -> PingEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PingEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PingEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PingEvent> for PingEvent

fn from(value: &PingEvent) -> Self

Converts to this type from the input type.

impl From<PingEvent> for PingEvent

fn from(value: PingEvent) -> Self

Converts to this type from the input type.

impl Serialize for PingEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PingEvent> for PingEvent

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: PingEvent) -> Result<Self, String>

Performs the conversion.