The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Webhook Step Plugin

registerWebhook: Creates and returns a webhook that can be used by an external system to notify a pipeline

Returns a unique webhook that can be used with waitForWebhook to block pipeline execution until external notification. The returned webhook has String getToken() and String getURL() methods.
  • authToken (optional)
    • Type: String
  • token (optional)
    • Type: String

waitForWebhook: Wait for webhook to be POSTed to by external system

Blocks on a webhook created with registerWebhook until the registered webhook is posted to. In general, should not be used inside of a node block.
  • webhookToken
    • Type: class org.jenkinsci.plugins.webhookstep.WebhookToken
  • withHeaders (optional)
    • Type: boolean

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.