Create a Session Watch

curl --request POST \
  --url https://api.checkfu.com/v1/sessions/{id}/watches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "source": {
    "kind": "github_pr",
    "connection_id": "<string>",
    "repository": "<string>",
    "pull_request": 1
  },
  "target_ref": "<string>",
  "coalescing_window_seconds": 43200
}
'

import requests

url = "https://api.checkfu.com/v1/sessions/{id}/watches"

payload = {
    "source": {
        "kind": "github_pr",
        "connection_id": "<string>",
        "repository": "<string>",
        "pull_request": 1
    },
    "target_ref": "<string>",
    "coalescing_window_seconds": 43200
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    source: {
      kind: 'github_pr',
      connection_id: '<string>',
      repository: '<string>',
      pull_request: 1
    },
    target_ref: '<string>',
    coalescing_window_seconds: 43200
  })
};

fetch('https://api.checkfu.com/v1/sessions/{id}/watches', 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.checkfu.com/v1/sessions/{id}/watches",
  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([
    'source' => [
        'kind' => 'github_pr',
        'connection_id' => '<string>',
        'repository' => '<string>',
        'pull_request' => 1
    ],
    'target_ref' => '<string>',
    'coalescing_window_seconds' => 43200
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/sessions/{id}/watches"

	payload := strings.NewReader("{\n  \"source\": {\n    \"kind\": \"github_pr\",\n    \"connection_id\": \"<string>\",\n    \"repository\": \"<string>\",\n    \"pull_request\": 1\n  },\n  \"target_ref\": \"<string>\",\n  \"coalescing_window_seconds\": 43200\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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.checkfu.com/v1/sessions/{id}/watches")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": {\n    \"kind\": \"github_pr\",\n    \"connection_id\": \"<string>\",\n    \"repository\": \"<string>\",\n    \"pull_request\": 1\n  },\n  \"target_ref\": \"<string>\",\n  \"coalescing_window_seconds\": 43200\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/sessions/{id}/watches")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": {\n    \"kind\": \"github_pr\",\n    \"connection_id\": \"<string>\",\n    \"repository\": \"<string>\",\n    \"pull_request\": 1\n  },\n  \"target_ref\": \"<string>\",\n  \"coalescing_window_seconds\": 43200\n}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "owner_session_id": "<string>",
  "source": {
    "kind": "github_pr",
    "connection_id": "<string>",
    "repository": "<string>",
    "pull_request": 1
  },
  "target_ref": "<string>",
  "status": "active",
  "coalescing_window_seconds": 43200,
  "last_source_state_hash": "<string>",
  "version": 1,
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Create a Session Watch

Creates a Watch that wakes this Session when watched provider state changes. The body names a source (kind: "github_pr" with a governed connection_id, repository, and pull_request), a target_ref, and an optional coalescing_window_seconds debounce of up to 86,400. Creation reads current provider state through the Connection and records the normalized snapshot hash as the baseline, so only a real change wakes the Session; a provider webhook is only a hint and its payload is never Run input. Accepts an Idempotency-Key, returns the Watch with 201, and records watch.created in the event ledger.

Checkfu support posture: alpha; hosted. Required evidence journey: session-turn. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

sessions

{id}

watches

Create a Session Watch

curl --request POST \
  --url https://api.checkfu.com/v1/sessions/{id}/watches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "source": {
    "kind": "github_pr",
    "connection_id": "<string>",
    "repository": "<string>",
    "pull_request": 1
  },
  "target_ref": "<string>",
  "coalescing_window_seconds": 43200
}
'

import requests

url = "https://api.checkfu.com/v1/sessions/{id}/watches"

payload = {
    "source": {
        "kind": "github_pr",
        "connection_id": "<string>",
        "repository": "<string>",
        "pull_request": 1
    },
    "target_ref": "<string>",
    "coalescing_window_seconds": 43200
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    source: {
      kind: 'github_pr',
      connection_id: '<string>',
      repository: '<string>',
      pull_request: 1
    },
    target_ref: '<string>',
    coalescing_window_seconds: 43200
  })
};

fetch('https://api.checkfu.com/v1/sessions/{id}/watches', 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.checkfu.com/v1/sessions/{id}/watches",
  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([
    'source' => [
        'kind' => 'github_pr',
        'connection_id' => '<string>',
        'repository' => '<string>',
        'pull_request' => 1
    ],
    'target_ref' => '<string>',
    'coalescing_window_seconds' => 43200
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/sessions/{id}/watches"

	payload := strings.NewReader("{\n  \"source\": {\n    \"kind\": \"github_pr\",\n    \"connection_id\": \"<string>\",\n    \"repository\": \"<string>\",\n    \"pull_request\": 1\n  },\n  \"target_ref\": \"<string>\",\n  \"coalescing_window_seconds\": 43200\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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.checkfu.com/v1/sessions/{id}/watches")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": {\n    \"kind\": \"github_pr\",\n    \"connection_id\": \"<string>\",\n    \"repository\": \"<string>\",\n    \"pull_request\": 1\n  },\n  \"target_ref\": \"<string>\",\n  \"coalescing_window_seconds\": 43200\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/sessions/{id}/watches")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": {\n    \"kind\": \"github_pr\",\n    \"connection_id\": \"<string>\",\n    \"repository\": \"<string>\",\n    \"pull_request\": 1\n  },\n  \"target_ref\": \"<string>\",\n  \"coalescing_window_seconds\": 43200\n}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "owner_session_id": "<string>",
  "source": {
    "kind": "github_pr",
    "connection_id": "<string>",
    "repository": "<string>",
    "pull_request": 1
  },
  "target_ref": "<string>",
  "status": "active",
  "coalescing_window_seconds": 43200,
  "last_source_state_hash": "<string>",
  "version": 1,
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

idempotency-key

string

Maximum string length: 255

Path Parameters

string

required

Pattern: ^sess_[0-9a-f]{32}$

Body

application/json

source

object

required

Show child attributes

target_ref

string

required

Required string length: 1 - 1024

Pattern: ^\S+$

coalescing_window_seconds

integer

Required range: 0 < x <= 86400

Response

Watch

string

required

Pattern: ^wch_[0-9a-f]{32}$

workspace_id

string

required

Pattern: ^wrkspc_[0-9a-f]{32}$

owner_session_id

string

required

Pattern: ^sess_[0-9a-f]{32}$

source

object

required

Show child attributes

target_ref

string

required

Required string length: 1 - 1024

Pattern: ^\S+$

status

enum<string>

required

Available options:

active,

paused

coalescing_window_seconds

integer

required

Required range: 0 < x <= 86400

last_source_state_hash

string | null

required

Pattern: ^sha256:[0-9a-f]{64}$

version

integer

required

Required range: x > 0

created_at

string

required

updated_at

string

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Create a Session Watch

Authorizations

Headers

Path Parameters

Body

Response