Carbon

Webhook

The webhook resource.

Basehttps://rest.carbon.ms/webhook
GET/webhook

List webhooks

Retrieve a paginated list of webhooks. 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/webhook
curl --request GET \
  --url 'https://rest.carbon.ms/webhook?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "table": "string",
    "url": "string",
    "active": true,
    "onInsert": true,
    "onUpdate": true,
    "onDelete": true
  }
]
GET/webhook

Retrieve a webhook

Fetch a single webhook by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/webhook
curl --request GET \
  --url 'https://rest.carbon.ms/webhook?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "table": "string",
  "url": "string",
  "active": true,
  "onInsert": true,
  "onUpdate": true,
  "onDelete": true
}
POST/webhook

Create a webhook

Create a new webhook.

Body parameters

namestringrequired
tablestringrequired

References webhookTable.table

urlstringrequired
activebooleanrequired
onInsertbooleanrequired
onUpdatebooleanrequired
onDeletebooleanrequired
successCountnumberrequired
lastSuccesstimestamp
errorCountnumberrequired
lastErrortimestamp
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/webhook
curl --request POST \
  --url https://rest.carbon.ms/webhook \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","table":"string","url":"string","active":true,"onInsert":true,"onUpdate":true,"onDelete":true,"successCount":10,"errorCount":10,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "table": "string",
  "url": "string",
  "active": true,
  "onInsert": true,
  "onUpdate": true,
  "onDelete": true
}
PATCH/webhook

Update a webhook

Update an existing webhook, matched on `id`.

Body parameters

namestringrequired
tablestringrequired

References webhookTable.table

urlstringrequired
activebooleanrequired
onInsertbooleanrequired
onUpdatebooleanrequired
onDeletebooleanrequired
successCountnumberrequired
lastSuccesstimestamp
errorCountnumberrequired
lastErrortimestamp
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/webhook
curl --request PATCH \
  --url 'https://rest.carbon.ms/webhook?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "table": "string",
  "url": "string",
  "active": true,
  "onInsert": true,
  "onUpdate": true,
  "onDelete": true
}
DELETE/webhook

Delete a webhook

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/webhook
curl --request DELETE \
  --url 'https://rest.carbon.ms/webhook?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content