Google Functions
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to GOOGLE_FUNCTION_INVOKE . |
function_name Required | String | The name of the Google function. |
integration Required | Integration | The integration. |
application_id Required | String | The id of the Google Cloud project. |
payload | String | The JSON that will be provided as input to the Google function. |
region | String | Region in which function can be found or will be created. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{
"name": "Invoke function hello-world-0",
"type": "GOOGLE_FUNCTION_INVOKE",
"trigger_time": "ON_EVERY_EXECUTION",
"integration": {
"identifier": "my_integration"
},
"function_name": "hello-world-0",
"payload": "{\r\n \"revision\": \"$BUDDY_EXECUTION_REVISION\",\r\n \"message\": \"$BUDDY_EXECUTION_REVISION_MESSAGE\",\r\n \"pipelineId\": \"$BUDDY_PIPELINE_ID\",\r\n \"id\": \"$BUDDY_EXECUTION_ID\"\r\n}"
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "Invoke function hello-world-0",
"type": "GOOGLE_FUNCTION_INVOKE",
"input_type": "SCM_REPOSITORY",
"trigger_time": "ON_EVERY_EXECUTION",
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/my-id",
"hash_id": "5ddb7c180fb38be67bd78a88a",
"identifier": "my_integration"
},
"function_name": "hello-world-0",
"payload": "{\r\n \"revision\": \"$BUDDY_EXECUTION_REVISION\",\r\n \"message\": \"$BUDDY_EXECUTION_REVISION_MESSAGE\",\r\n \"pipelineId\": \"$BUDDY_PIPELINE_ID\",\r\n \"id\": \"$BUDDY_EXECUTION_ID\"\r\n}",
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/my-id",
"id": 1
},
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "test server",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Last modified on March 22, 2024