Webhook

As explained in Platform Engineering on Kubernetes

A webhook is an HTTP callback that allows one system to notify another system when an event occurs.

A webhook lets a repository notify a service pipeline when source or configuration changes occur. The notification can trigger a pipeline instance instead of waiting for the next polling cycle. section 3.4.2 section 4.1.3

Use webhooks within a broader pipeline workflow:

• Register access to the Git repository so a pipeline can receive notifications when changes merge into the main branch. section 3.4.2
• Use a webhook to prompt configuration synchronization, then clone the desired state and apply it to the live Kubernetes environment. section 4.1.3
• Keep polling as a fallback for GitOps updates rather than depending entirely on webhook delivery. section 4.1.3

Figure 3.5 Running pipelines requires a lot of infrastructure to be in place. This includes maintaining services and repositories, creating users and credentials, and making sure that these services (repositories) are accessible from remote locations.

Use the infrastructure view to identify the repositories, services, credentials, and network access required for webhook-driven pipelines. section 3.4.2

How Platform Engineering on Kubernetes covers it

How deep it goes

Explains webhook registration and pipeline triggering, while stopping short of protocol-level implementation details.

Examples

Uses merged source changes and environment-configuration changes as webhook-triggered pipeline events.

What it assumes

Assumes a reachable Git repository, pipeline access, credentials, and network connectivity between required services.

What you can do after

Operate/configure pipelines that react to repository changes while retaining polling as a synchronization fallback.

How it connects

Connects webhooks to Git repositories, service pipelines, environment pipelines, polling, GitOps, and Kubernetes.

liveBookmanning.com

Read Platform Engineering on Kubernetes on liveBook Get the book at manning.com

Also explained in

• 

  liveBookmanning.com
  The Design of Web APIs, Second EditionA webhook call is an HTTP request sent automatically to notify a consumer when an event occurs.
• 

  liveBookmanning.com
  Contract Testing in ActionA webhook is an HTTP callback that delivers an event notification from one system to another when a specified event occurs.
• 

  liveBookmanning.com
  Effective Platform EngineeringA webhook is an HTTP callback mechanism that delivers event notifications from one system to another when specified events occur.
• 

  liveBookmanning.com
  Secure APIsA webhook is an HTTP callback that delivers event notifications to a user-specified URL.
• 

  liveBookmanning.com
  Effective Conversational AIA webhook is an API endpoint that is invoked automatically when a specified event occurs in another system.

Compare how 6 books explain webhook →

Related concepts

• contractkind of · An API contract is a specification of the operations, data, and behavioral expectations that govern interactions between software components.
• business problemaddresses · A business problem is an organizational need, objective, constraint, or challenge that a proposed solution is intended to address.
• Pact Broker CLIproduced by · A command-line interface for publishing and managing Pact contracts and interacting with a Pact Broker.
• triggerkind of · A trigger is an event, condition, input, or schedule that causes or signals an action, process, or state transition to begin or proceed.
• pollingaddresses · Polling is the repeated checking or querying of a resource, system, or condition, often at intervals, to detect data, events, or state changes.
• JSONuses · JSON is a standardized, language-independent text format for representing structured data using objects, arrays, strings, numbers, Boolean values, and null.

This explainer was generated by Manning's knowledge graph from the text of Platform Engineering on Kubernetes. The section links point to the parts of the book it draws on.