Webhook endpoints

Webhook endpoints receive events from Twentybaan at your HTTPS URL.

The webhook endpoint model

Endpoint secrets are never returned by the API. Manage secrets in Settings → Integrations.

Properties

Name

id

Type

integer

Description

Unique identifier for the webhook endpoint.
Name

url

Type

string

Description

Destination URL for webhook requests (HTTPS only).
Name

events

Type

string[]

Description

Enabled webhook events for the endpoint.
Name

status

Type

string

Description

Current status (for example active, disabled).

GET/v1/webhook-endpoints/

List webhook endpoints

Retrieve a paginated list of webhook endpoints for the authenticated user.

Required scope

webhooks:manage

Request

GET

/v1/webhook-endpoints/

curl -G https://api.twentybaan.com/v1/webhook-endpoints/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d limit=10

GET

/v1/webhook-endpoints/

const token = process.env.TWENTYBAAN_API_KEY;

const url = new URL("https://api.twentybaan.com/v1/webhook-endpoints/");
url.searchParams.set("limit", "10");

const res = await fetch(url.toString(), {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

GET

/v1/webhook-endpoints/

type TwentybaanWebhookEndpoint = {
  id: number;
  url: string;
  events: string[];
  source: string;
  source_ref: string | null;
  status: string;
  last_success_at: string | null;
  last_error_at: string | null;
  last_error: string | null;
  created_at: string;
  updated_at: string;
};

type TwentybaanWebhookEndpointsResponse =
  | { ok: true; items: TwentybaanWebhookEndpoint[]; next_before_id: number | null }
  | { ok: false; error: string };

const token = process.env.TWENTYBAAN_API_KEY!;

const url = new URL("https://api.twentybaan.com/v1/webhook-endpoints/");
url.searchParams.set("limit", "10");

const res = await fetch(url.toString(), {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const data = (await res.json()) as TwentybaanWebhookEndpointsResponse;
if (!res.ok || !data.ok) throw new Error("Request failed");

console.log(data.items);

GET

/v1/webhook-endpoints/

import os
import requests

token = os.environ["TWENTYBAAN_API_KEY"]

res = requests.get(
  "https://api.twentybaan.com/v1/webhook-endpoints/",
  headers={
    "Accept": "application/json",
    "Authorization": f"Bearer {token}",
  },
  params={"limit": 10},
  timeout=30,
)
res.raise_for_status()
print(res.json())

GET

/v1/webhook-endpoints/

<?php

$token = getenv('TWENTYBAAN_API_KEY') ?: '';

$url = "https://api.twentybaan.com/v1/webhook-endpoints/" . '?' . http_build_query(['limit' => 10]);

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer " . $token,
  ],
]);

$body = curl_exec($ch);
$status = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo "HTTP {$status}\n";
echo $body;

GET

/v1/webhook-endpoints/

using System;
using System.Net.Http;
using System.Net.Http.Headers;

var token = Environment.GetEnvironmentVariable("TWENTYBAAN_API_KEY") ?? "";

var url = "https://api.twentybaan.com/v1/webhook-endpoints/?limit=10";

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

var res = await client.GetAsync(url);
var body = await res.Content.ReadAsStringAsync();

Console.WriteLine((int)res.StatusCode);
Console.WriteLine(body);

GET

/v1/webhook-endpoints/

require "net/http"
require "json"

token = ENV.fetch("TWENTYBAAN_API_KEY")
uri = URI("https://api.twentybaan.com/v1/webhook-endpoints/")
uri.query = URI.encode_www_form({ limit: 10 })

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Authorization"] = "Bearer #{token}"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(req)
end

puts res.code
puts res.body

GET

/v1/webhook-endpoints/

package main

import (
  "fmt"
  "io"
  "net/http"
  "net/url"
  "os"
  "time"
)

func main() {
  token := os.Getenv("TWENTYBAAN_API_KEY")

  u, err := url.Parse("https://api.twentybaan.com/v1/webhook-endpoints/")
  if err != nil {
    panic(err)
  }

  q := u.Query()
  q.Set("limit", "10")
  u.RawQuery = q.Encode()

  req, err := http.NewRequest("GET", u.String(), nil)
  if err != nil {
    panic(err)
  }

  req.Header.Set("Accept", "application/json")
  req.Header.Set("Authorization", "Bearer "+token)

  client := &http.Client{Timeout: 30 * time.Second}
  res, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()

  body, _ := io.ReadAll(res.Body)
  fmt.Println(res.Status)
  fmt.Println(string(body))
}

Response

{
  "ok": true,
  "items": [
    {
      "id": 123,
      "url": "https://example.com/webhooks/twentybaan",
      "events": ["contact_message.created", "listing.published"],
      "source": "user",
      "source_ref": null,
      "status": "active",
      "last_success_at": null,
      "last_error_at": null,
      "last_error": null,
      "created_at": "2026-01-12T08:00:00Z",
      "updated_at": "2026-01-12T08:00:00Z"
    }
  ],
  "next_before_id": null
}

GET/v1/webhook-endpoints/?id=:id

Retrieve a webhook endpoint

Fetch a single webhook endpoint by id.

Required scope

webhooks:manage

Request

GET

/v1/webhook-endpoints/?id=123

curl -G https://api.twentybaan.com/v1/webhook-endpoints/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d id=123

GET

/v1/webhook-endpoints/?id=123

const token = process.env.TWENTYBAAN_API_KEY;

const url = new URL("https://api.twentybaan.com/v1/webhook-endpoints/");
url.searchParams.set("id", "123");

const res = await fetch(url.toString(), {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

GET

/v1/webhook-endpoints/?id=123

type TwentybaanWebhookEndpointResponse =
  | { ok: true; endpoint: Record<string, unknown> }
  | { ok: false; error: string };

const token = process.env.TWENTYBAAN_API_KEY!;

const url = new URL("https://api.twentybaan.com/v1/webhook-endpoints/");
url.searchParams.set("id", "123");

const res = await fetch(url.toString(), {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const data = (await res.json()) as TwentybaanWebhookEndpointResponse;
if (!res.ok || !data.ok) throw new Error("Request failed");

console.log(data.endpoint);

GET

/v1/webhook-endpoints/?id=123

import os
import requests

token = os.environ["TWENTYBAAN_API_KEY"]

res = requests.get(
  "https://api.twentybaan.com/v1/webhook-endpoints/",
  headers={
    "Accept": "application/json",
    "Authorization": f"Bearer {token}",
  },
  params={"id": 123},
  timeout=30,
)
res.raise_for_status()
print(res.json())

GET

/v1/webhook-endpoints/?id=123

<?php

$token = getenv('TWENTYBAAN_API_KEY') ?: '';

$url = "https://api.twentybaan.com/v1/webhook-endpoints/" . '?' . http_build_query(['id' => 123]);

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer " . $token,
  ],
]);

$body = curl_exec($ch);
$status = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo "HTTP {$status}\n";
echo $body;

GET

/v1/webhook-endpoints/?id=123

using System;
using System.Net.Http;
using System.Net.Http.Headers;

var token = Environment.GetEnvironmentVariable("TWENTYBAAN_API_KEY") ?? "";

var url = "https://api.twentybaan.com/v1/webhook-endpoints/?id=123";

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

var res = await client.GetAsync(url);
var body = await res.Content.ReadAsStringAsync();

Console.WriteLine((int)res.StatusCode);
Console.WriteLine(body);

GET

/v1/webhook-endpoints/?id=123

require "net/http"
require "json"

token = ENV.fetch("TWENTYBAAN_API_KEY")
uri = URI("https://api.twentybaan.com/v1/webhook-endpoints/")
uri.query = URI.encode_www_form({ id: 123 })

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Authorization"] = "Bearer #{token}"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(req)
end

puts res.code
puts res.body

GET

/v1/webhook-endpoints/?id=123

package main

import (
  "fmt"
  "io"
  "net/http"
  "net/url"
  "os"
  "time"
)

func main() {
  token := os.Getenv("TWENTYBAAN_API_KEY")

  u, err := url.Parse("https://api.twentybaan.com/v1/webhook-endpoints/")
  if err != nil {
    panic(err)
  }

  q := u.Query()
  q.Set("id", "123")
  u.RawQuery = q.Encode()

  req, err := http.NewRequest("GET", u.String(), nil)
  if err != nil {
    panic(err)
  }

  req.Header.Set("Accept", "application/json")
  req.Header.Set("Authorization", "Bearer "+token)

  client := &http.Client{Timeout: 30 * time.Second}
  res, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()

  body, _ := io.ReadAll(res.Body)
  fmt.Println(res.Status)
  fmt.Println(string(body))
}