Application - Deploy
Set GitHub Webhook
Integrate Square Cloud with GitHub webhooks.
POST
/
v2
/
apps
/
{app_id}
/
deploy
/
webhook
Set GitHub Webhook
curl --request POST \
--url https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"access_token": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload = { "access_token": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({access_token: '<string>'})
};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook', 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.squarecloud.app/v2/apps/{app_id}/deploy/webhook",
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([
'access_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload := strings.NewReader("{\n \"access_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"access_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
}
}
The API key for your account. You can find this in your account settings.
Parameters
The ID of the application. You can find this in the URL of your application’s dashboard.
The access token for your GitHub repository. You can find this in your GitHub Tokens Classic
Response
Indicates whether the call was successful..
success if successful, error if not.{
"status": "success",
"response": {
"webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
}
}
⌘I
Set GitHub Webhook
curl --request POST \
--url https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"access_token": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload = { "access_token": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({access_token: '<string>'})
};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook', 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.squarecloud.app/v2/apps/{app_id}/deploy/webhook",
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([
'access_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload := strings.NewReader("{\n \"access_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"access_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
}
}

