Properties
| Name | Type | Description |
|---|---|---|
| hook | object | The webhook that is being pinged |
| hook_id | integer | The ID of the webhook that triggered the ping. |
| organization | object | |
| repository | object | |
| sender | object | |
| zen | string | Random string of GitHub zen. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhook-ping",
"title": "webhook-ping",
"type": "object",
"properties": {
"hook": {
"title": "Webhook",
"description": "The webhook that is being pinged",
"type": "object",
"properties": {
"active": {
"description": "Determines whether the hook is actually triggered for the events it subscribes to.",
"type": "boolean"
},
"app_id": {
"description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.",
"type": "integer"
},
"config": {
"type": "object",
"properties": {
"content_type": {
"$ref": "#/components/schemas/webhook-config-content-type"
},
"insecure_ssl": {
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
},
"secret": {
"$ref": "#/components/schemas/webhook-config-secret"
},
"url": {
"$ref": "#/components/schemas/webhook-config-url"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"deliveries_url": {
"type": "string",
"format": "uri"
},
"events": {
"description": "Determines what events the hook is triggered for. Default: ['push'].",
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"description": "Unique identifier of the webhook.",
"type": "integer"
},
"last_response": {
"$ref": "#/components/schemas/hook-response"
},
"name": {
"description": "The type of webhook. The only valid value is 'web'.",
"type": "string",
"enum": [
"web"
]
},
"ping_url": {
"type": "string",
"format": "uri"
},
"test_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"type",
"name",
"active",
"events",
"config",
"created_at",
"updated_at"
]
},
"hook_id": {
"description": "The ID of the webhook that triggered the ping.",
"type": "integer"
},
"organization": {
"$ref": "#/components/schemas/organization-simple-webhooks"
},
"repository": {
"$ref": "#/components/schemas/repository-webhooks"
},
"sender": {
"$ref": "#/components/schemas/simple-user-webhooks"
},
"zen": {
"description": "Random string of GitHub zen.",
"type": "string"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/apis-io-engineering-platform-webhook-ping"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.