Skip to main content
PATCH
Update webhook

Authorizations

x-api-key
string
header
required

API key for authentication.

Path Parameters

webhook_id
string<uuid>
required

Unique webhook identifier.

Body

application/json

All fields are optional. Only supplied fields are updated.

name
string

Updated webhook name.

Example:

"Layoffs Alert (EU)"

url
string<uri>

Updated destination URL. Must use HTTPS. Type-specific URL rules apply.

Example:

"https://hooks.slack.com/services/T000/B111/yyyy"

type
enum<string>

Webhook target type.

  • generic: Sends the raw result payload to any HTTPS endpoint.
  • slack: Sends a formatted Slack Block Kit message. URL must start with https://hooks.slack.com/.
  • teams: Sends a formatted Microsoft Teams Adaptive Card. URL hostname must match *webhook.office.com or *.webhook.office365.com.
  • custom: Sends a transformed payload using the configuration in formatter_config. Requires formatter_config to be set.

When type is omitted, it is auto-detected from the URL.

Available options:
generic,
slack,
teams,
custom
delivery_mode
enum<string>

Delivery mode for webhook payloads.

  • full: Sends all records in a single request on each trigger.
  • per_record: Sends one request per record. For large result sets, this may generate many requests.
Available options:
full,
per_record
method
enum<string>

HTTP method used for webhook delivery.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
headers
object

Updated HTTP headers. Replaces existing headers entirely.

Example:
params
object

Updated query parameters. Replaces existing params entirely.

Example:
auth
object

Updated authentication configuration. Replaces existing auth entirely.

formatter_config
object | null

Updated custom payload formatter. Set only when type is custom.

is_active
boolean

Set to false to disable delivery without deleting the webhook.

Example:

false

Response

Webhook updated successfully.

success
boolean
required

True if the webhook was updated; false otherwise.

Example:

true

message
string
required

Human-readable result message.

Example:

"Webhook updated successfully."

webhook
object

The updated webhook object.