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':
Webhook URL location
A box will appear with a URL that can be used to run the pipeline from a remote service:
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 revisionrevision=38ebd0cc80895dadbf0e8c3d667123630f64ec6a
(example)
Upload from scratchfromScratch=1
Clear cacheclearCache=1
Commentcomment=my%20comment
Branch (for wildcard pipeline)branch=dev
Tag (for wildcard pipeline)tag=mytag
Custom ENV VARsmyenv=value
Examples
HTTP GET
with parameters in query:
GET
https://app.buddy.works/buddyworks/buddy-demo/pipelines/pipeline/189325/trigger-webhook?token=98a7a230afe6827ba8a2cd1e96c626ba6b0d0e289a25ef9094129bc28d02763f703bfea3d8e37fe2dabe61875b242f51&revision=38ebd0cc80895dadbf0e8c3d667123630f64ec6a
HTTP POST
with Content-Type: application/json
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
POST
https://app.buddy.works/buddyworks/buddy-demo/pipelines/pipeline/189325/trigger-webhook?token=98a7a230afe6827ba8a2cd1e96c626ba6b0d0e289a25ef9094129bc28d02763f703bfea3d8e37fe2dabe61875b242f51
fromScratch=1
&tag=version%201
%env=val
Apr 12, 2024