CircleCI · Schema

WebhookInfo

CI/CDContinuous IntegrationContinuous DeploymentDevOpsPipelinesWorkflows

Properties

Name	Type	Description
id	string	The unique identifier of the webhook
url	string	The URL the webhook delivers to
name	string	The name of the webhook
events	array	The events this webhook subscribes to
scope	object	The scope of the webhook
signing-secret	string	The signing secret for verifying webhook payloads
verify-tls	boolean	Whether to verify TLS certificates
created-at	string	When the webhook was created
updated-at	string	When the webhook was last updated

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookInfo",
  "title": "WebhookInfo",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the webhook"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL the webhook delivers to"
    },
    "name": {
      "type": "string",
      "description": "The name of the webhook"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "workflow-completed",
          "job-completed"
        ]
      },
      "description": "The events this webhook subscribes to"
    },
    "scope": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The scope ID"
        },
        "type": {
          "type": "string",
          "description": "The scope type"
        }
      },
      "description": "The scope of the webhook"
    },
    "signing-secret": {
      "type": "string",
      "description": "The signing secret for verifying webhook payloads"
    },
    "verify-tls": {
      "type": "boolean",
      "description": "Whether to verify TLS certificates"
    },
    "created-at": {
      "type": "string",
      "format": "date-time",
      "description": "When the webhook was created"
    },
    "updated-at": {
      "type": "string",
      "format": "date-time",
      "description": "When the webhook was last updated"
    }
  }
}