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

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.

Servers

Path parameters

Name Type Required Description
table_id Integer Yes

The id of the table that must be tested.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
use_user_field_names Boolean No

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

url String Yes

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

event_type String Yes

The event type that must be used for the test call.

  • 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

Possible values:

  • "rows.created"
  • "view.created"
  • "rows.deleted"
  • "field.deleted"
  • "view.rows_entered"
  • "rows.updated"
  • "view.updated"
  • "view.deleted"
  • "field.updated"
  • "field.created"
request_method String No

The request method that be used when the event occurs.

  • POST - Post
  • GET - Get
  • PUT - Put
  • PATCH - Patch
  • DELETE - Delete

Possible values:

  • "POST"
  • "PUT"
  • "DELETE"
  • "GET"
  • "PATCH"
headers Object No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.