Update webhook
The endpoint allows you to update the existing webhook with a given identifier
Request schema
Path parameters
webhookId
stringrequired
The webhook ID
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
url
stringrequired
Your webhooks URL endpoint for your application.
example:
events
arrayrequired
The array of event types.
example:
type:
active
boolean
Boolean, if set to true, webhooks are immediately sent in response to events.
example:
secret
string
The secret string used for payload signing.
example:
Http + 1.1
PATCH
https://api.fivetran.com/v1/webhooks/webhookId
PATCH /v1/webhooks/webhookId HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 157
{
"url": "https://your-host.your-domain/webhook",
"events": [
"sync_start",
"sync_end"
],
"active": true,
"secret": "your_webhook_secret"
}Responses
200
Successful response
404
Webhook not found
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
id
stringrequired
The webhook ID.
example:
type
stringrequired
The webhook type.
enum:
url
stringrequired
Your webhooks URL endpoint for your application.
example:
events
arrayrequired
The array of event types.
example:
type:
active
booleanrequired
Boolean, if set to true, webhooks are immediately sent in response to events.
example:
secret
string
The secret string used for payload signing.
example:
created_at
stringrequired
The webhook creation timestamp.
format:
example:
created_by
stringrequired
The ID of the user who created the webhook.
example:
group_id
string
The group ID.
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "webhook_id",
"type": "group",
"url": "https://your-host.your-domain/webhook",
"events": [
"sync_start",
"sync_end"
],
"active": true,
"secret": "******",
"created_at": "2024-01-01T00:00:00Z",
"created_by": "user_id",
"group_id": "group_id"
}
}