Skip to content
Datanotes

Webhooks of the change feed: id, url, filter (tables, ops, columns, exclude_actor), `cursor` (last change delivered), `status` (ok, failing, disabled), `last_delivery`, `last_error`. Secrets are not shown.

POST
/datanotes/operations/list_webhooks/
curl --request POST \
  --url https://example.com/datanotes/operations/list_webhooks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Webhooks of the change feed: id, url, filter (tables, ops, columns, exclude_actor), cursor (last change delivered), status (ok, failing, disabled), last_delivery, last_error. Secrets are not shown.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object

Example generated

{}

Responses

Section titled “Responses”

200

Section titled “200”

Done.

Media typeapplication/json
object
webhooks
required
Array<object>
Webhook

A webhook of the change feed (its secret is never listed).

object
id
required

Webhook id (wh_…).

string
url
required

Receiver URL.

string
tables
Array<string>
kinds
Array<string>
Allowed values: insert update delete move metastore tool_call unreadable
columns
Array<string>
exclude_actor
string
where

Row filter.

object
key
additional properties
any
enabled
required
boolean
cursor
required

Last sequence number delivered (or skipped by the filter).

integer
created_at
required

ISO date-time.

string
last_delivery

ISO date-time of the last delivery.

string
last_error
string
failures
required

Consecutive failed deliveries.

integer
status
required

Delivery state.

string
Allowed values: ok failing disabled

Example 

{
  "webhooks": [
    {
      "kinds": [
        "insert"
      ],
      "status": "ok"
    }
  ]
}

400

Section titled “400”

Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.

Media typeapplication/json
object
error
required

What went wrong, for a person or an agent.

string

Example generated

{
  "error": "example"
}

401

Section titled “401”

Missing or wrong bearer token.

Media typeapplication/json
object
error
required

What went wrong, for a person or an agent.

string

Example generated

{
  "error": "example"
}

500

Section titled “500”

Unexpected error.

Media typeapplication/json
object
error
required

What went wrong, for a person or an agent.

string

Example generated

{
  "error": "example"
}