Google Functions

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to GOOGLE_FUNCTION_INVOKE.
function_namerequired string
The name of the Google function.
integrationrequired string
The integration.
application_idrequired string
The id of the Google Cloud project.
payloadoptional string
The JSON that will be provided as input to the Google function.
regionoptional string
Region in which function can be found or will be created.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Invoke function hello-world-0",
  "type": "GOOGLE_FUNCTION_INVOKE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "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}"
}'
EXAMPLE RESPONSE
{ "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", "id": 1 }, "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}", "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999