Webhook Table

The webhook table resource.

Basehttps://rest.carbon.ms/webhookTable

GET/webhookTable

List webhook tables

Retrieve a paginated list of webhook tables. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/webhookTable

curl --request GET \
  --url 'https://rest.carbon.ms/webhookTable?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "table": "string",
    "module": "string",
    "name": "Example"
  }
]

GET/webhookTable

Retrieve a webhook table

Fetch a single webhook table by filtering on `table`.

Query parameters

tablestring

Match on the webhook table's `table`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/webhookTable

curl --request GET \
  --url 'https://rest.carbon.ms/webhookTable?table=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "table": "string",
  "module": "string",
  "name": "Example"
}

POST/webhookTable

Create a webhook table

Create a new webhook table.

Body parameters

modulestringrequired

namestringrequired

POSThttps://rest.carbon.ms/webhookTable

curl --request POST \
  --url https://rest.carbon.ms/webhookTable \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"module":"string","name":"Example"}'

Response

{
  "table": "string",
  "module": "string",
  "name": "Example"
}

PATCH/webhookTable

Update a webhook table

Update an existing webhook table, matched on `table`.

Body parameters

modulestringrequired

namestringrequired

PATCHhttps://rest.carbon.ms/webhookTable

curl --request PATCH \
  --url 'https://rest.carbon.ms/webhookTable?table=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"module":"string"}'

Response

{
  "table": "string",
  "module": "string",
  "name": "Example"
}

DELETE/webhookTable

Delete a webhook table

Delete a webhook table, matched on `table`. Returns 204 No Content.

Query parameters

tablestring

The `table` of the webhook table to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/webhookTable

curl --request DELETE \
  --url 'https://rest.carbon.ms/webhookTable?table=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content