Struct PingEventHook

pub struct PingEventHook {

    pub active: bool,
    pub app_id: Option<i64>,
    pub config: PingEventHookConfig,
    pub created_at: DateTime<Utc>,
    pub deliveries_url: String,
    pub events: WebhookEvents,
    pub id: i64,
    pub last_response: Option<PingEventHookLastResponse>,
    pub name: String,
    pub ping_url: String,
    pub test_url: Option<String>,
    pub type_: PingEventHookType,
    pub updated_at: DateTime<Utc>,
    pub url: String,
}

The webhook configuration.

JSON schema

{
 "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
}

Fields

active: bool

app_id: Option<i64>

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 an app.

config: PingEventHookConfig

created_at: DateTime<Utc>

deliveries_url: String

events: WebhookEvents

id: i64

last_response: Option<PingEventHookLastResponse>

name: String

ping_url: String

test_url: Option<String>

type_: PingEventHookType

updated_at: DateTime<Utc>

url: String

Implementations

impl PingEventHook

pub fn builder() -> PingEventHook

Trait Implementations

impl Clone for PingEventHook

fn clone(&self) -> PingEventHook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PingEventHook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PingEventHook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PingEventHook> for PingEventHook

fn from(value: &PingEventHook) -> Self

Converts to this type from the input type.

impl From<PingEventHook> for PingEventHook

fn from(value: PingEventHook) -> Self

Converts to this type from the input type.

impl Serialize for PingEventHook

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PingEventHook> for PingEventHook

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.