Bind a webhook source to an Automation

curl --request POST \
  --url https://api.checkfu.com/v1/automations/{id}/webhook-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "connection_id": "<string>",
  "resource": {
    "resource_type": "<string>",
    "external_id": "<string>"
  }
}
'

import requests

url = "https://api.checkfu.com/v1/automations/{id}/webhook-sources"

payload = {
    "connection_id": "<string>",
    "resource": {
        "resource_type": "<string>",
        "external_id": "<string>"
    }
}
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({
    connection_id: '<string>',
    resource: {resource_type: '<string>', external_id: '<string>'}
  })
};

fetch('https://api.checkfu.com/v1/automations/{id}/webhook-sources', 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/automations/{id}/webhook-sources",
  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([
    'connection_id' => '<string>',
    'resource' => [
        'resource_type' => '<string>',
        'external_id' => '<string>'
    ]
  ]),
  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/automations/{id}/webhook-sources"

	payload := strings.NewReader("{\n  \"connection_id\": \"<string>\",\n  \"resource\": {\n    \"resource_type\": \"<string>\",\n    \"external_id\": \"<string>\"\n  }\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/automations/{id}/webhook-sources")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\n  \"resource\": {\n    \"resource_type\": \"<string>\",\n    \"external_id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/automations/{id}/webhook-sources")

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  \"connection_id\": \"<string>\",\n  \"resource\": {\n    \"resource_type\": \"<string>\",\n    \"external_id\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "automation_id": "<string>",
  "connection_id": "<string>",
  "provider": "<string>",
  "resource": {
    "resource_type": "<string>",
    "external_id": "<string>"
  },
  "subscription": {
    "external_installation_id": "<string>",
    "surface_scope_id": "<string>",
    "source": {
      "kind": "conversation",
      "conversation": {
        "kind": "ambient",
        "root_external_id": "<string>",
        "thread_external_id": null
      },
      "resource_type": "<unknown>",
      "external_id": "<unknown>"
    }
  },
  "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"
  }
}

Bind a webhook source to an Automation

Bind one governed Connection, optionally recording the provider resource it follows, so provider events the credential custody aggregator forwards are verified at that boundary, re-signed with this Automation’s own ingest secret, and delivered through the identical ingest path a organization-signed request uses; dedupe, admission filtering, filtered records, and firing semantics are unchanged. Requires a webhook or subscription trigger and an active Connection the Automation’s creator owns; a subscription additionally requires the Connection provider to match its active CollaborationInstallation. An Automation holds at most 16 sources, enforced atomically. Accepts an optional Idempotency-Key.

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

POST

automations

{id}

webhook-sources

Bind a webhook source to an Automation

curl --request POST \
  --url https://api.checkfu.com/v1/automations/{id}/webhook-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "connection_id": "<string>",
  "resource": {
    "resource_type": "<string>",
    "external_id": "<string>"
  }
}
'

import requests

url = "https://api.checkfu.com/v1/automations/{id}/webhook-sources"

payload = {
    "connection_id": "<string>",
    "resource": {
        "resource_type": "<string>",
        "external_id": "<string>"
    }
}
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({
    connection_id: '<string>',
    resource: {resource_type: '<string>', external_id: '<string>'}
  })
};

fetch('https://api.checkfu.com/v1/automations/{id}/webhook-sources', 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/automations/{id}/webhook-sources",
  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([
    'connection_id' => '<string>',
    'resource' => [
        'resource_type' => '<string>',
        'external_id' => '<string>'
    ]
  ]),
  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/automations/{id}/webhook-sources"

	payload := strings.NewReader("{\n  \"connection_id\": \"<string>\",\n  \"resource\": {\n    \"resource_type\": \"<string>\",\n    \"external_id\": \"<string>\"\n  }\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/automations/{id}/webhook-sources")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\n  \"resource\": {\n    \"resource_type\": \"<string>\",\n    \"external_id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/automations/{id}/webhook-sources")

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  \"connection_id\": \"<string>\",\n  \"resource\": {\n    \"resource_type\": \"<string>\",\n    \"external_id\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "automation_id": "<string>",
  "connection_id": "<string>",
  "provider": "<string>",
  "resource": {
    "resource_type": "<string>",
    "external_id": "<string>"
  },
  "subscription": {
    "external_installation_id": "<string>",
    "surface_scope_id": "<string>",
    "source": {
      "kind": "conversation",
      "conversation": {
        "kind": "ambient",
        "root_external_id": "<string>",
        "thread_external_id": null
      },
      "resource_type": "<unknown>",
      "external_id": "<unknown>"
    }
  },
  "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: ^auto_[0-9a-f]{32}$

Body

application/json

connection_id

string

required

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

resource

object | null

Show child attributes

Response

WebhookSource

string

required

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

workspace_id

string

required

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

automation_id

string

required

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

connection_id

string

required

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

provider

string

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

resource

object | null

required

Show child attributes

subscription

object | null

required

Show child attributes

version

integer

required

Required range: x > 0

created_at

string

required

updated_at

string

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Bind a webhook source to an Automation

Authorizations

Headers

Path Parameters

Body

Response