Event System Trigger

The event system trigger resource.

Basehttps://rest.carbon.ms/eventSystemTrigger

GET/eventSystemTrigger

List event system triggers

Retrieve a paginated list of event system triggers. 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/eventSystemTrigger

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

Response

[
  {
    "tableName": "string",
    "type": "string",
    "attachedFunctions": "string",
    "status": "string",
    "systemTriggerName": "string"
  }
]

GET/eventSystemTrigger

Retrieve a event system trigger

Fetch a single event system trigger by filtering on `tableName`.

Query parameters

tableNamestring

Match on the event system trigger's `tableName`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/eventSystemTrigger

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

Response

{
  "tableName": "string",
  "type": "string",
  "attachedFunctions": "string",
  "status": "string",
  "systemTriggerName": "string"
}

POST/eventSystemTrigger

Create a event system trigger

Create a new event system trigger.

Body parameters

tableNamestring

typestring

attachedFunctionsstring

statusstring

systemTriggerNamestring

POSThttps://rest.carbon.ms/eventSystemTrigger

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

Response

{
  "tableName": "string",
  "type": "string",
  "attachedFunctions": "string",
  "status": "string",
  "systemTriggerName": "string"
}

PATCH/eventSystemTrigger

Update a event system trigger

Update an existing event system trigger, matched on `tableName`.

Body parameters

tableNamestring

typestring

attachedFunctionsstring

statusstring

systemTriggerNamestring

PATCHhttps://rest.carbon.ms/eventSystemTrigger

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

Response

{
  "tableName": "string",
  "type": "string",
  "attachedFunctions": "string",
  "status": "string",
  "systemTriggerName": "string"
}

DELETE/eventSystemTrigger

Delete a event system trigger

Delete a event system trigger, matched on `tableName`. Returns 204 No Content.

Query parameters

tableNamestring

The `tableName` of the event system trigger to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/eventSystemTrigger

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

204 No Content