Sign in
Database table webhooks

This endpoint triggers a test call based on the provided data if the user has access to the workspace related to the table. The test call will be made immediately and a copy of the request, response and status will be included in the response.

post/api/database/webhooks/table/{table_id}/test-call/

Path parameters

table_idinteger required

The id of the table that must be tested.

Request body

urlstring required

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

event_type'rows.created' | 'rows.updated' | 'rows.deleted' | 'field.created' | 'field.updated' | 'field.deleted' | 'view.created' | 'view.updated' | 'view.deleted' | 'view.rows_entered' required
  • rows.created - rows.created
  • rows.updated - rows.updated
  • rows.deleted - rows.deleted
  • field.created - field.created
  • field.updated - field.updated
  • field.deleted - field.deleted
  • view.created - view.created
  • view.updated - view.updated
  • view.deleted - view.deleted
  • view.rows_entered - view.rows_entered
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.

use_user_field_namesboolean

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

Response

requeststring required

A text copy of the request headers and body.

responsestring required

A text copy of the response headers and body.

status_codeinteger required

The HTTP response status code.

is_unreachableboolean required

Indicates whether the provided URL could be reached.

Changes

No recorded changes to this endpoint across all 6 revisions of this API.