Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Database table webhooks

Updates the existing view if the authorized user has access to the related database workspace.

patch/api/database/webhooks/{webhook_id}/

Path parameters

webhook_idinteger required

Updates the webhook related to the provided value.

Request body

urlstring

The URL that must be called when the webhook is triggered.

include_all_eventsboolean

Indicates whether this webhook should listen to all events.

eventsEventsEnum[]

A list containing the events that will trigger this webhook.

request_method'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE'
  • POST - Post
  • GET - Get
  • PUT - Put
  • PATCH - Patch
  • DELETE - Delete
headersobject

The additional headers as an object where the key is the name and the value the value.

namestring

An internal name of the webhook.

activeboolean

Indicates whether the web hook is active. When a webhook has failed multiple times, it will automatically be deactivated.

use_user_field_namesboolean

Indicates whether the field names must be used as payload key instead of the id.

Response

idinteger required
eventsobject required

A list containing the events that will trigger this webhook.

headersobject required

The additional headers as an object where the key is the name and the value the value.

created_onstring date-time required
updated_onstring date-time required
use_user_field_namesboolean

Indicates whether the field names must be used as payload key instead of the id.

urlstring required

The URL that must be called when the webhook is triggered.

request_method'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE'
  • POST - Post
  • GET - Get
  • PUT - Put
  • PATCH - Patch
  • DELETE - Delete
namestring required

An internal name of the webhook.

include_all_eventsboolean

Indicates whether this webhook should listen to all events.

failed_triggersinteger

The amount of failed webhook calls.

activeboolean

Indicates whether the web hook is active. When a webhook has failed multiple times, it will automatically be deactivated.