Webhooks

If you want to trigger your pipeline with a webhook, go to the given pipeline, click on the burger menu (3 dots) and select 'Webhook URL':

Image loading...Webhook URL location

A box will appear with a URL that can be used to run the pipeline from a remote service:

Image loading...HTTP Request

By default, every request will trigger an execution to the HEAD revision in the branch. Optionally, you can send some parameters to customize the execution. These parameters can be sent either in a URL query, or as POST parameters.

Parameters

Run to revision
revision=38ebd0cc80895dadbf0e8c3d667123630f64ec6a (example)

Upload from scratch
fromScratch=1

Clear cache
clearCache=1

Comment
comment=my%20comment

Branch (for wildcard pipeline)
branch=dev

Tag (for wildcard pipeline)
tag=mytag

Custom ENV VARs
myenv=value

Examples

HTTP GET with parameters in query:

http
GET https://app.buddy.works/buddyworks/buddy-demo/pipelines/pipeline/189325/trigger-webhook?token=98a7a230afe6827ba8a2cd1e96c626ba6b0d0e289a25ef9094129bc28d02763f703bfea3d8e37fe2dabe61875b242f51&revision=38ebd0cc80895dadbf0e8c3d667123630f64ec6a

HTTP POST with Content-Type: application/json

javascript
POST https://app.buddy.works/buddyworks/buddy-demo/pipelines/pipeline/189325/trigger-webhook?token=98a7a230afe6827ba8a2cd1e96c626ba6b0d0e289a25ef9094129bc28d02763f703bfea3d8e37fe2dabe61875b242f51 { "comment": "my comment", "clearCache": 1, "env1": "env value" }

HTTP POST with Content-Type: application/x-www-form-urlencoded

http
POST https://app.buddy.works/buddyworks/buddy-demo/pipelines/pipeline/189325/trigger-webhook?token=98a7a230afe6827ba8a2cd1e96c626ba6b0d0e289a25ef9094129bc28d02763f703bfea3d8e37fe2dabe61875b242f51 fromScratch=1 &tag=version%201 %env=val

Last modified on Sep 23, 2024