Functions

Link a GitHub repository

Bind a repository to this function so every push to branch deploys it. A function holds at most one link; linking again returns 400.

The server decides how the link authenticates. If the project has the Zavu GitHub App installed, the link uses that installation: private repositories work and there is nothing to configure in the repository. Otherwise it falls back to a manual link and the response carries a webhookSecret you add to the repository yourself. connection says which one you got.

The repository is not checked against GitHub here, because it cannot be: an owner/repo that does not exist, or that the installation cannot see, is accepted and fails on the first deploy with a fetch error.

POST

functions

{functionId}

git-link

Link a GitHub repository

curl --request POST \
  --url https://api.zavu.dev/v1/functions/{functionId}/git-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "owner": "acme",
  "repo": "order-bot",
  "branch": "main"
}
'

import requests

url = "https://api.zavu.dev/v1/functions/{functionId}/git-link"

payload = {
    "owner": "acme",
    "repo": "order-bot",
    "branch": "main"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({owner: 'acme', repo: 'order-bot', branch: 'main'})
};

fetch('https://api.zavu.dev/v1/functions/{functionId}/git-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zavu.dev/v1/functions/{functionId}/git-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'owner' => 'acme',
    'repo' => 'order-bot',
    'branch' => 'main'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zavu.dev/v1/functions/{functionId}/git-link"

	payload := strings.NewReader("{\n  \"owner\": \"acme\",\n  \"repo\": \"order-bot\",\n  \"branch\": \"main\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.zavu.dev/v1/functions/{functionId}/git-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner\": \"acme\",\n  \"repo\": \"order-bot\",\n  \"branch\": \"main\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/functions/{functionId}/git-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"owner\": \"acme\",\n  \"repo\": \"order-bot\",\n  \"branch\": \"main\"\n}"

response = http.request(request)
puts response.read_body

{
  "link": {
    "id": "<string>",
    "functionId": "<string>",
    "provider": "github",
    "owner": "acme",
    "repo": "order-bot",
    "branch": "main",
    "autoDeploy": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "rootDir": "<string>",
    "lastCommitSha": "<string>",
    "lastCommitMessage": "<string>",
    "lastError": "<string>",
    "lastDeployAt": "2023-11-07T05:31:56Z"
  },
  "webhookUrl": "<string>",
  "webhookSecret": "ghs_a1b2c3..."
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

functionId

string

required

Zavu Function ID.

Body

application/json

owner

string

required

Example:

"acme"

repo

string

required

Example:

"order-bot"

branch

string

default:main

rootDir

string

Subdirectory holding the project, for monorepos.

Example:

"apps/bot"

autoDeploy

boolean

default:true

Response

Link created. The only response that ever carries webhookSecret.

link

object

required

A GitHub repository bound to a function. A push to branch deploys the function. A function holds at most one link.

Show child attributes

webhookUrl

string<uri>

required

Endpoint that receives GitHub's push deliveries. Only needed on a manual link, where you add it to the repository yourself.

webhookSecret

string

Shared secret for the repository's webhook. Returned only when creating a manual link, and only there — every later read strips it, and re-linking mints a new one. Absent entirely on an app link, which needs no secret of its own.

Example:

"ghs_a1b2c3..."

⌘I

Link a GitHub repository

curl --request POST \
  --url https://api.zavu.dev/v1/functions/{functionId}/git-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "owner": "acme",
  "repo": "order-bot",
  "branch": "main"
}
'

import requests

url = "https://api.zavu.dev/v1/functions/{functionId}/git-link"

payload = {
    "owner": "acme",
    "repo": "order-bot",
    "branch": "main"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({owner: 'acme', repo: 'order-bot', branch: 'main'})
};

fetch('https://api.zavu.dev/v1/functions/{functionId}/git-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zavu.dev/v1/functions/{functionId}/git-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'owner' => 'acme',
    'repo' => 'order-bot',
    'branch' => 'main'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zavu.dev/v1/functions/{functionId}/git-link"

	payload := strings.NewReader("{\n  \"owner\": \"acme\",\n  \"repo\": \"order-bot\",\n  \"branch\": \"main\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.zavu.dev/v1/functions/{functionId}/git-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner\": \"acme\",\n  \"repo\": \"order-bot\",\n  \"branch\": \"main\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/functions/{functionId}/git-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"owner\": \"acme\",\n  \"repo\": \"order-bot\",\n  \"branch\": \"main\"\n}"

response = http.request(request)
puts response.read_body

{
  "link": {
    "id": "<string>",
    "functionId": "<string>",
    "provider": "github",
    "owner": "acme",
    "repo": "order-bot",
    "branch": "main",
    "autoDeploy": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "rootDir": "<string>",
    "lastCommitSha": "<string>",
    "lastCommitMessage": "<string>",
    "lastError": "<string>",
    "lastDeployAt": "2023-11-07T05:31:56Z"
  },
  "webhookUrl": "<string>",
  "webhookSecret": "ghs_a1b2c3..."
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}