Update a Webhook

The endpoint allows you to update the existing webhook with a given identifier

Request schema

Path parameters

webhookId

stringrequired

The webhook ID

example:

webhookId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

url

stringrequired

The endpoint URL where webhook events will be delivered.

example:

https://your-host.your-domain/webhook

events

arrayrequired

List of event types that trigger the webhook.

example:

sync_start,sync_end

type:

string

active

boolean

Indicates if the webhook is enabled to send events immediately upon occurrence.

example:

true

secret

string

A secret string used to sign webhook payloads for verification.

example:

your_webhook_secret

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:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

Unique identifier for the webhook.

example:

webhook_id

type

stringrequired

The type of the webhook. Specifies whether the webhook is associated with a group or an account.

enum:

"group""account"

url

stringrequired

The endpoint URL where webhook events will be delivered.

example:

https://your-host.your-domain/webhook

events

arrayrequired

List of event types that trigger the webhook.

example:

sync_start,sync_end

type:

string

active

booleanrequired

Indicates if the webhook is enabled to send events immediately upon occurrence.

example:

true

secret

string

A secret string used to sign webhook payloads for verification.

example:

******

created_at

stringrequired

Timestamp indicating when the webhook was created.

format:

date-time

example:

2024-01-01T00:00:00Z

created_by

stringrequired

Identifier of the user who created the webhook setting.

example:

user_id

group_id

string

Unique identifier for the group associated with the webhook.

example:

group_id

{
  "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"
  }
}