List all Webhooks

The endpoint allows you to retrieve the list of existing webhooks available for the current account

Request schema

Query parameters

cursor

string

Paging cursor, read more about pagination

example:

trDfa54Ffs9hj

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/webhooks

GET /v1/webhooks?cursor=trDfa54Ffs9hj&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Host: api.fivetran.com

Responses

200

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

items

arrayrequired

The collection of returned items

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

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "items": [
      {
        "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"
      }
    ],
    "next_cursor": "cursor_value"
  }
}