PATCH /api/database/webhooks/{webhook_id}/

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

Servers

/

Path parameters

Name	Type	Required	Description
`webhook_id`	Integer	Yes	Updates the webhook related to the provided value.

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.
`name`	String	No	An internal name of the webhook.
`active`	Boolean	No	Indicates whether the web hook is active. When a webhook has failed multiple times, it will automatically be deactivated.
`url`	String	No	The URL that must be called when the webhook is triggered.
`include_all_events`	Boolean	No	Indicates whether this webhook should listen to all events.
`event_config[]`	Array	No	A list containing the addition event options.
`event_config[].views[]`	Array	No	A list of view IDs that are related to the event.
`event_config[].event_type`	String	Yes	The type of the event. `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"`
`event_config[].fields[]`	Array	No	A list of field IDs that are related to the event.
`events[]`	Array	No	A list containing the events that will trigger this webhook.
`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

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.