Trigger Google Functions

POST Parameters

NameTypeDescription
function_name
Required
StringThe name of the Google function.
integration
Required
IntegrationThe integration.
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
application_id
Required
StringThe id of the Google Cloud project.
type
Required
StringThe type of the action. Should be set to GOOGLE_FUNCTIONS.
payloadStringThe JSON that will be provided as input to the Google function.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Invoke function hello-world",
"type": "GOOGLE_FUNCTIONS",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"integration": {
"id": 1
},
"function_name": "projects/tokyo-house-138923/locations/us-central1/functions/buddy-function",
"payload": "{\r\n \"message\": \"$BUDDY_EXECUTION_COMMENT\"\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",
"type": "GOOGLE_FUNCTIONS",
"input_type": "SCM_REPOSITORY",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"integration": {
"id": 1
},
"function_name": "projects/tokyo-house-138923/locations/us-central1/functions/buddy-function",
"payload": "{\r\n \"message\": \"$BUDDY_EXECUTION_COMMENT\"\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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}