Database table webhooks

Changed on

Creates a new webhook for the table related to the provided table_id parameter if the authorized user has access to the related database workspace.

post/api/database/webhooks/table/{table_id}/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/database/webhooks/table/{table_id}/
  • Auth
    HTTP bearer

Path parameters

table_idinteger required

Creates a webhook for the table related to the provided value.

Request body

urlstring required

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 required

An internal name of the webhook.

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.

Changes